I/O Docs: API Documentation

Test our API services using I/O Docs. You can also view our written documentation.

Select an Interactive Documentation
Mashery API V2
Mashery API V3
Mashery API V3 - Authentication (Do Not Touch)
Mashery Developer API V3
Mashery Organization API V3
Mashery Reporting API V3

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.

OAuth 2.0 Flow:

Existing Client Credentials:

API Key:

App/Key: Manually provide key information

Shared Secret:

Client ID:

Client Secret:

Client ID:

Client Secret:

Username:

Password:

Client ID:

Client Secret:

Authorization Code:

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

Administration Methods

List Methods

Expand Methods

POST Call Mashery API (JSON-RPC) /v2/json-rpc/:site_id

Query.

Parameter	Value	Type	Description
:site_id		string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'

Request Body

Reporting Methods

List Methods

Expand Methods

GET CallsQPSForArea /v2/rest/:site_id/reports/calls/qps/area

For a specific customer, returns the details related to Calls, data transferred (bytes), connections.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid type is csv.

GET CallsQPSForDeveloper /v2/rest/:site_id/reports/calls/qps/developer

For a specific customer, returns the data related to Calls, data transferred (bytes), connections regarding MAPI.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid type is csv.

GET CallsQPSForEndpoint /v2/rest/:site_id/reports/calls/qps/endpoint

For a specific customer, returns the data related to Calls, data transferred (bytes), connections regarding endpoints.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid type is csv.

GET AreaPlatformLatencyPercentileNinetyFive /v2/rest/:site_id/reports/area/platformlatency/percentile-ninety-five

For a specific customer and date range, returns the calculated overall 95th percentile of latency for the area.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.

GET CallsCountsChangeOverTime /v2/rest/:site_id/reports/calls/counts/change_over_time

Returns counts of calls in a current and previous time period and calculates the percentage change comparison

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.
start_date_compare	date-time	Oldest date for which comparison data should be retrieved. Must be less than (earlier) than the start_date.
end_date_compare	date-time	Most recent date for which comparison data should be retrieved. Must be greater (later) than the start_date_compare.

GET KeysUsageConsistency /v2/rest/:site_id/reports/keys/usage/consistency

For a specific customer, date range returns the average count of API keys with traffic per day, the total count of API keys with traffic in the time interval, and the ratio of average count and total count aka Usage Consistency.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET PercentageCommunicationAvailablity /v2/rest/:site_id/reports/percentage/communication/availability

For a specific customer and date range, returns the call volume by status codes and the calculation for Communication Availability.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaQpsRate /v2/rest/:site_id/reports/area/qpsrate

For a specific customer and date range, returns the maximum calls per second for the area.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaDataServed /v2/rest/:site_id/reports/area/data-served

For a specific customer and date range, returns the volume of data served through the area.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaCacheHitRate /v2/rest/:site_id/reports/area/cache-hit-rate

For a specific customer and date range, returns the rate of api calls served through the Mashery Cache relative to the total call volume through the area.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaCountMembersRegistered /v2/rest/:site_id/reports/area/count/members-registered

For a specific customer and date range, returns the count of members registered within the time period.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaCountApplicationsCreated /v2/rest/:site_id/reports/area/count/applications-created

For a specific customer and date range, returns the count of applications created within the time period.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaCountKeysDistributed /v2/rest/:site_id/reports/area/count/keys-distributed

For a specific customer and date range, returns the count of keys distributed within the time period.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET TotalCallsPackagesSummary /v2/rest/:site_id/reports/total/calls/packages-summary

For a specific customer and date range, returns a timechart count of all calls

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaPlatformStatusTrend /v2/rest/:site_id/reports/area/platform-status/trend

For a specific customer, and date range, returns a time chart of the sum of api calls with status codes 503 or 504.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaPlatformAvailabilityTrend /v2/rest/:site_id/reports/area/platform-availablity/trend

For a specific customer, and date range, returns a time chart of the percetage of api calls with status codes 503 or 504.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaQpsTrend /v2/rest/:site_id/reports/area/qps/trend

For a specific customer, and date range, returns a time chart of the maximum calls per second.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaDataServedTrend /v2/rest/:site_id/reports/area/data-served/trend

For a specific customer, and date range, returns a time chart of data served in units of Gigabytes.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 365 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 365 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 365 days later than your start date.

GET AreaPlatformStatus /v2/rest/:site_id/reports/area/platform/status

For a specific customer, and for the trailing 24 hour time period, returns the ratio of the the sum of api calls with status codes 503 or 504 over the total count of api calls for the specified time period.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.

GET CallsDeveloperActivityForService /v2/rest/:site_id/reports/calls/developer_activity/service/:service_key

For a specific service, returns a summary across the report interval of activity by Developer. Sort order of the returned data is number of successful calls for each developer, in descending order.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsErrorcodesForService /v2/rest/:site_id/reports/calls/errorcodes/service/:service_key

For a specific service, returns time-based counts of errors

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
errorcode_limit	integer	Limit on the number of distinct errorcodes for which data should be returned.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsErrorcodesForServiceForDeveloper /v2/rest/:site_id/reports/calls/errorcodes/service/:service_key/developer/:service_dev_key

For a specific service, for a specific developer, call count by error code.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
:service_dev_key	string	Developer's Key for the Service (API) for which you want to get reporting data.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
errorcode_limit	integer	Limit on the number of distinct errorcodes for which data should be returned.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsErrorcountByDeveloperForService /v2/rest/:site_id/reports/calls/errorcount_by_developer/service/:service_key

For a specific service, returns error count broken out by Developer

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsErrorcountByMethodForService /v2/rest/:site_id/reports/calls/errorcount_by_method/service/:service_key

For a specific service, returns time-based counts of errors further broken out by Method

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsLatencyForService /v2/rest/:site_id/reports/calls/latency/service/:service_key

For a specific service, returns call latency breaking out Mashery Proxy and the Client API

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsLatencyByMethodForService /v2/rest/:site_id/reports/calls/latency_by_method/service/:service_key

For a specific service, returns time-based average of call latency further broken out by Method PLUS some other details TBD

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
method_limit	integer	Limit on the number of distinct methods for which data should be returned.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsLatencyByResponsecodeForService /v2/rest/:site_id/reports/calls/latency_by_responsecode/service/:service_key

For a specific service, returns time-based average of call latency further broken out by response code PLUS some other details

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
method_limit	integer	Limit on the number of distinct methods for which data should be returned.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsStatusForServiceForDeveloper /v2/rest/:site_id/reports/calls/status/service/:service_key/developer/:service_dev_key

For a specific service, for a specific developer, call status.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
:service_dev_key	string	Developer's Key for the Service (API) for which you want to get reporting data.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsMethodsForService /v2/rest/:site_id/reports/calls/methods/service/:service_key

For a specific service, returns time-based count of calls by method

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
method_limit	integer	Limit on the number of distinct methods for which data should be returned.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsMethodsForServiceForDeveloper /v2/rest/:site_id/reports/calls/methods/service/:service_key/developer/:service_dev_key

For a specific service, for a specific developer, call count by method.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
method_limit	integer	Limit on the number of distinct methods for which data should be returned.
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
:service_dev_key	string	Developer's Key for the Service (API) for which you want to get reporting data.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsMedianVolumeByHourForService /v2/rest/:site_id/reports/calls/median_volume_by_hour/service/:service_key

For a specific service, across the specified interval, returns median call volume by hour for a 24-hour day.

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsResponsesFromCacheForService /v2/rest/:site_id/reports/calls/responses_from_cache/service/:service_key

For a specific service, returns time-based percentage of successful call responses that were from Mashery Cache

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsStatusForService /v2/rest/:site_id/reports/calls/status/service/:service_key

For a specific service, returns time-based count of calls by status

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsGeolocationForService /v2/rest/:site_id/reports/calls/geolocation/service/:service_key

For a specific service, returns a summary across the report interval of originating geolocation of calls

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

GET CallsGeolocationForServiceForDeveloper /v2/rest/:site_id/reports/calls/geolocation/service/:service_key/developer/:service_dev_key

For a specific service and developer, returns a summary across the report interval of originating geolocation of calls

Parameter	Type	Description
:site_id	string	Your designated Mashery site identifier. To find out your site id, go to your Mashery Dashboard and look at the bottom of the page for the text 'Mashery Site ID.'
:service_key	string	Mashery API ID for the Service (API) for which you want to get reporting data. This ID can be found on the API Settings page for the Service in the Mashery Dashboard.
:service_dev_key	string	Developer's Key for the Service (API) for which you want to get reporting data.
start_date	date-time	Oldest date for which data should be retrieved. If not specified, the date will be 7 days prior to the end_date. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your start data cannot be more than 7 days earlier than your end date.
end_date	date-time	Most recent date for which data should be retrieved, non-inclusive (meaning the data returned will be up to the date-time provided and not including). If not specified, the date will be the start of the day - 00:00 GMT - when the API call is made. The type is a timestamp literal and must be specified in ISO 8601 format in UTC time: YYYY-MM-DDThh:mm:ssZ. An example is 2011-12-01T00:00:00Z. Your end data cannot be more than 7 days later than your start date.
format		Desired output format. Valid types are csv and json. Default type is csv.
limit	integer	Limit on the number of items that will be returned.

Services

List Methods

Expand Methods

GET fetch all /services

Retrieves collection of Service Definitions belonging to the given Area

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /services/:serviceId

Retrieves the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

POST create /services

Creates a new Service Definition in the given Area.

Parameter	Value	Type	Description
Content-Type		string	Content type of the payload
Accept		string	The content type to request from the server.

Request Body

PUT update /services/:serviceId

Updates the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId

Deletes the identified Service Definition.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.

ServiceRoles

List Methods

Expand Methods

GET fetch all /services/:serviceId/roles

Retrieves all Roles currently assigned to the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

PUT update /services/:serviceId

Assigns roles to the identified Service Definition.

You can add multiple {"id":"RoleId","action":"read"} objects to the roles array to add as many assigned roles to the Service Definition as needed.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT delete /services/:serviceId

Deletes all of the Roles assigned to the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

SecurityProfile

List Methods

Expand Methods

GET fetch /services/:serviceId/securityProfile

Retrieves the identified Security Profile for the Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

PUT update /services/:serviceId/securityProfile

Updates the identified Security Profile for the Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

OAuth

List Methods

Expand Methods

GET fetch /services/:serviceId/securityProfile/oauth

Retrieves the identified Security Profile OAuth for the Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

POST create /services/:serviceId/securityProfile/oauth

Assigns Security Profile OAuth to a Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/securityProfile/oauth

Updates the Security Profile OAuth assigned to the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/securityProfile/oauth

Deletes the Security Profile OAuth assigned to the identified Service Definition.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.

ServiceCache

List Methods

Expand Methods

GET fetch /services/:serviceId/cache

Retrieves the identified Cache for the Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

POST create /services/:serviceId/cache

Assigns Cache to a Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/cache

Updates the Cache assigned to the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/cache

Deletes the Cache assigned to the identified Service Definition.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.

ErrorSets

List Methods

Expand Methods

GET fetch all /services/:serviceId/errorSets

Retrieves collection of ErrorSets in the identified Service Definition, returning an Array of ErrorSets

Parameter	Type	Description
:serviceId	string	Service identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /services/:serviceId/errorSets/:errorSetId

Retrieves the identified ErrorSet, returning a Service Definition ErrorSet

Parameter	Type	Description
:serviceId	string	Service identifier.
:errorSetId	string	Error Set identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /services/:serviceId/errorSets

Creates a new ErrorSet in the given Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/errorSets/:errorSetId

Updates the identified ErrorSet.

Parameter	Type	Description
:serviceId	string	Service identifier.
:errorSetId	string	Error Set identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/errorSets/:errorSetId

Deletes the identified ErrorSet.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.
:errorSetId		string	Error Set identifier.

ErrorMessages

List Methods

Expand Methods

GET fetch all /services/:serviceId/errorSets/:errorSetId/errorMessages

Retrieves collection of ErrorMessages in the identified ErrorSet, returning an Array of ErrorMessages

Parameter	Type	Description
:serviceId	string	Service identifier.
:errorSetId	string	Error Set identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /services/:serviceId/errorSets/:errorSetId/errorMessages/messageType

Retrieves the identified ErrorMessage, returning a Service Definition ErrorMessage

Parameter	Type	Description
:serviceId	string	Service identifier.
:errorSetId	string	Error Set identifier.
messageType	string	Error Message identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

PUT update /services/:serviceId/errorSets/:errorSetId/errorMessages/messageType

Updates the identified ErrorMessage.

Parameter	Type	Description
:serviceId	string	Service identifier.
:errorSetId	string	Error Set identifier.
messageType	string	Error Message identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

Endpoints

List Methods

Expand Methods

GET fetch all /services/:serviceId/endpoints

Retrieves collection of Endpoints in the identified Service Definition, returning an Array of Service Definition Endpoints

Parameter	Type	Description
:serviceId	string	Service identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /services/:serviceId/endpoints/:endpointId

Retrieves the identified Endpoint, returning a Service Definition Endpoint

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /services/:serviceId/endpoints

Creates a new Endpoint in the given Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/endpoints/:endpointId

Updates the identified Endpoint.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/endpoints/:endpointId

Deletes the identified Endpoint.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.
:endpointId		string	Endpoint identifier.

ScheduledMaintenanceEvent

List Methods

Expand Methods

GET fetch /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent

Retrieves the identified ScheduledMaintenanceEventEndpoint for the Service Definition Endpoint.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent

Assigns Cache to a Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent

Updates the ScheduledMaintenanceEventEndpoint assigned to the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/endpoints/:endpointId/scheduledMaintenanceEvent

Deletes the ScheduledMaintenanceEventEndpoint assigned to the identified Service Definition Endpoint.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.
:endpointId		string	Endpoint identifier.

EndpointCache

List Methods

Expand Methods

GET fetch /services/:serviceId/endpoints/:endpointId/cache

Retrieves the identified Cache for the Endpoint Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /services/:serviceId/endpoints/:endpointId/cache

Assigns Cache to an Endpoint Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/endpoints/:endpointId/cache

Updates the Cache assigned to the identified Endpoint Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/endpoints/:endpointId/cache

Deletes the Cache assigned to the identified Endpoint Definition.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.
:endpointId		string	Endpoint identifier.

Cors

List Methods

Expand Methods

GET fetch /services/:serviceId/endpoints/:endpointId/cors

Retrieves the identified Cors for the Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /services/:serviceId/endpoints/:endpointId/cors

Assigns Cors to a Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/endpoints/:endpointId/cors

Updates the Cors assigned to the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/endpoints/:endpointId/cors

Deletes the Cors assigned to the identified Service Definition.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.
:endpointId		string	Endpoint identifier.

Roles

List Methods

Expand Methods

GET fetch all /roles

Retrieves collection of Service Definitions belonging to the given Area

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

SystemDomainAuthentication

List Methods

Expand Methods

GET fetch /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication

Retrieves the identified SystemDomainAuthentication for the Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication

Assigns SystemDomainAuthentication to a Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication

Updates the SystemDomainAuthentication assigned to the identified Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/endpoints/:endpointId/systemDomainAuthentication

Deletes the SystemDomainAuthentication assigned to the identified Service Definition.

Parameter	Value	Type	Description
:serviceId		string	Service identifier.
:endpointId		string	Endpoint identifier.

Methods

List Methods

Expand Methods

GET fetch all /services/:serviceId/endpoints/:endpointId/methods

Retrieves collection of Methods for the Endpoint in the identified Service Definition, returning an Array of Service Definition Methods

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

GET fetch /services/:serviceId/endpoints/:endpointId/methods/:methodId

Retrieves the identified Method for the Endpoint, returning a Service Definition Method

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
:methodId	string	Method identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /services/:serviceId/endpoints/:endpointId/methods

Creates a new Service Definition Method in the given Endpoint in the given Service Definition.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/endpoints/:endpointId/methods/:methodId

Updates the identified Service Definition Method.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
:methodId	string	Method identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/endpoints/:endpointId/methods/:methodId

Deletes the identified Service Definition Method.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
:methodId	string	Method identifier.

Response Filters

List Methods

Expand Methods

GET fetch all /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters

Retrieves collection of ResponseFilters for the identified Service Definition Method, returning an Array of Response Filters

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
:methodId	string	Method identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

GET fetch /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId

Retrieves the identified Response Filter for the specified Service Definition Method

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
:methodId	string	Method identifier.
:responseFilterId	string	Response Filter identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters

Creates a new Method Response Filter associated with a Service Definition Method.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
:methodId	string	Method identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

PUT update /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId

Updates the identified Service Definition Method.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
:methodId	string	Method identifier.
:responseFilterId	string	Response Filter identifier.
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /services/:serviceId/endpoints/:endpointId/methods/:methodId/responseFilters/:responseFilterId

Deletes the identified Service Definition Method.

Parameter	Type	Description
:serviceId	string	Service identifier.
:endpointId	string	Endpoint identifier.
:methodId	string	Method identifier.
:responseFilterId	string	Response Filter identifier.

Email Template Sets

List Methods

Expand Methods

GET fetch all /emailTemplateSets

Retrieves collection of Email Template Sets with their respective Email Templates belonging to the given Area.

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /emailTemplateSets/:emailTemplateSetId

Retrieves the Email Template Sets, returning a Email Template Set

Parameter	Type	Description
:emailTemplateSetId	string	Email Template Set identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

Email Templates

List Methods

Expand Methods

GET fetch all /emailTemplateSets/:emailTemplateSetId/emailTemplates

Retrieves collection of Email Templates belonging to the given Email Template Set.

Parameter	Type	Description
:emailTemplateSetId	string	Email Template Set identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /emailTemplateSets/:emailTemplateSetId/emailTemplates/:emailTemplateId

Retrieves the Plan, returning a Plan

Parameter	Type	Description
:emailTemplateSetId	string	Email Template Set identifier.
:emailTemplateId	string	Email Template identifier.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

ScheduledMaintenanceEvents

List Methods

Expand Methods

GET fetch all /scheduledMaintenanceEvents

Retrieves collection of all Scheduled Maintenance Events objects belonging to the given Area

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /scheduledMaintenanceEvents/:scheduledMaintenanceEventId

Retrieves the identified Scheduled Maintenance Event.

Parameter	Type	Description
:scheduledMaintenanceEventId	string	The Scheduled Maintenance Event identifier
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /scheduledMaintenanceEvents

Creates a new Scheduled Maintenance Events in the given Area.

Parameter	Value	Type	Description
Content-Type		string	Content type of the payload
Accept		string	The content type to request from the server.

Request Body

PUT update /scheduledMaintenanceEvents/:scheduledMaintenanceEventId

Retrieves the identified Scheduled Maintenance Event.

Parameter	Type	Description
:scheduledMaintenanceEventId	string	The Scheduled Maintenance Event identifier
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /scheduledMaintenanceEvents/:scheduledMaintenanceEventId

Deletes the identified Scheduled Maintenance Event.

Parameter	Value	Type	Description
:scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier

ScheduledMaintenanceEventEndpoints

List Methods

Expand Methods

GET fetch all /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints

Retrieves collection of all Scheduled Maintenance Events objects belonging to the given Area

Parameter	Type	Description
:scheduledMaintenanceEventId	string	The Scheduled Maintenance Event identifier
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints/:scheduledMaintenanceEventEndpointId

Retrieves the identified Scheduled Maintenance Event.

Parameter	Type	Description
:scheduledMaintenanceEventId	string	The Scheduled Maintenance Event identifier
:scheduledMaintenanceEventEndpointId	string	The Scheduled Maintenance Event Endpoint identifier
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

POST create /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints

Creates a new Scheduled Maintenance Events in the given Area.

Parameter	Type	Description
:scheduledMaintenanceEventId	string	The Scheduled Maintenance Event identifier
Content-Type	string	Content type of the payload
Accept	string	The content type to request from the server.

Request Body

DELETE delete /scheduledMaintenanceEvents/:scheduledMaintenanceEventId/endpoints/:scheduledMaintenanceEventEndpointId

Deletes the identified Scheduled Maintenance Event.

Parameter	Value	Type	Description
:scheduledMaintenanceEventId		string	The Scheduled Maintenance Event identifier
:scheduledMaintenanceEventEndpointId		string	The Scheduled Maintenance Event Endpoint identifier

Domains

List Methods

Expand Methods

GET fetch all /domains

Retrieves collection of all Domain Whitelist objects belonging to the given Area

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

GET fetch /domains/:domainId

Retrieves the identified Domain Whitelist.

Parameter	Type	Description
:domainId	string	DomainWhitelist indentifier. String like '859437e4-b778-49ee-8635-0afa5f021465'.
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.

POST create /domains

Creates a new Domain WhiteList in the given Area.

Parameter	Value	Type	Description
Content-Type		string	Content type of the payload
Accept		string	The content type to request from the server.

Request Body

Public Endpoint Domain Path Methods

List Methods

Expand Methods

GET fetch all /domains/public

Retrieves collection of all Public Domain Endpoints belonging to the given Area

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

System Endpoint Domain Paths

List Methods

Expand Methods

GET fetch all /domains/system

Retrieves collection of all System Domain Endpoints belonging to the given Area

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

Unique Public Fully Qualified Domain Names

List Methods

Expand Methods

GET fetch all /domains/public/hostnames

Retrieves collection of all Public Domains belonging to the given Area

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

Unique System Fully Qualified Domain Names

List Methods

Expand Methods

GET fetch all /domains/system/hostnames

Retrieves collection of all System Domains belonging to the given Area

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=[,...][&sort=...]
limit	int	Number of objects to return in the result. Defaults to 100.
offset	int	0-based index of first object in the list to return. Defaults to 0.
indent	boolean	When set to true, responses are indented for better readability.

Packages

List Methods

Expand Methods

GET fetch all /packages

Retrieves collection of Packages with their respective Plans belonging to the given Area.

Parameter	Type	Description
fields	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=[,...][&fields=...]
filter	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=:[&filter=...]
sort	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed

I/O Docs: API Documentation

Administration Methods List Methods Expand Methods

Request Body

Reporting Methods List Methods Expand Methods

Services List Methods Expand Methods

Request Body

Request Body

ServiceRoles List Methods Expand Methods

Request Body

Request Body

SecurityProfile List Methods Expand Methods

Request Body

OAuth List Methods Expand Methods

Request Body

Request Body

ServiceCache List Methods Expand Methods

Request Body

Request Body

ErrorSets List Methods Expand Methods

Request Body

Request Body

ErrorMessages List Methods Expand Methods

Request Body

Endpoints List Methods Expand Methods

Request Body

Request Body

ScheduledMaintenanceEvent List Methods Expand Methods

Request Body

Request Body

EndpointCache List Methods Expand Methods

Request Body

Request Body

Cors List Methods Expand Methods

Request Body

Request Body

Roles List Methods Expand Methods

SystemDomainAuthentication List Methods Expand Methods

Request Body

Request Body

Methods List Methods Expand Methods

Request Body

Request Body

Response Filters List Methods Expand Methods

Request Body

Request Body

Email Template Sets List Methods Expand Methods

Email Templates List Methods Expand Methods

ScheduledMaintenanceEvents List Methods Expand Methods

Request Body

Request Body

ScheduledMaintenanceEventEndpoints List Methods Expand Methods

Request Body

Domains List Methods Expand Methods

Request Body

Public Endpoint Domain Path Methods List Methods Expand Methods

System Endpoint Domain Paths List Methods Expand Methods

Unique Public Fully Qualified Domain Names List Methods Expand Methods

Unique System Fully Qualified Domain Names List Methods Expand Methods

Packages List Methods Expand Methods

Administration Methods

List Methods

Expand Methods

Reporting Methods

List Methods

Expand Methods

Services

List Methods

Expand Methods

ServiceRoles

List Methods

Expand Methods

SecurityProfile

List Methods

Expand Methods

OAuth

List Methods

Expand Methods

ServiceCache

List Methods

Expand Methods

ErrorSets

List Methods

Expand Methods

ErrorMessages

List Methods

Expand Methods

Endpoints

List Methods

Expand Methods

ScheduledMaintenanceEvent

List Methods

Expand Methods

EndpointCache

List Methods

Expand Methods

Cors

List Methods

Expand Methods

Roles

List Methods

Expand Methods

SystemDomainAuthentication

List Methods

Expand Methods

Methods

List Methods

Expand Methods

Response Filters

List Methods

Expand Methods

Email Template Sets

List Methods

Expand Methods

Email Templates

List Methods

Expand Methods

ScheduledMaintenanceEvents

List Methods

Expand Methods

ScheduledMaintenanceEventEndpoints

List Methods

Expand Methods

Domains

List Methods

Expand Methods

Public Endpoint Domain Path Methods

List Methods

Expand Methods

System Endpoint Domain Paths

List Methods

Expand Methods

Unique Public Fully Qualified Domain Names

List Methods

Expand Methods

Unique System Fully Qualified Domain Names

List Methods

Expand Methods

Packages

List Methods

Expand Methods