Query operations

post

https://{hostname}/api-definitions/v2/search-operations

Get a filtered list of operations and their endpoints and resources. You can filter by date ranges, activation statuses, API Endpoint hostnames, and resource paths. For a simpler search, run Search operations.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Collects data used for generating operations reports filtered based on the specified criteria.

activeEndTime

string | null

If the queryType is ACTIVE_WITHIN_DATE_RANGE, specify the ISO 8601 timestamp for the end of the date range. Specify null to use the current time.

activeStartTime

string | null

If the queryType is ACTIVE_WITHIN_DATE_RANGE, specify the ISO 8601 timestamp for the start of the date range.

apiEndPointHosts

array of strings | null

Specify a list of API endpoint hostnames to filter on. Users access the Akamai-deployed API using these hostnames.

apiEndPointHosts

includeDetails

boolean | null

Specify true to include all the resource and operation details.

queryType

string

enum

required

Filter the results for an operation report. Choose ACTIVE_IN_PRODUCTION, ACTIVE_IN_STAGING, or ACTIVE_WITHIN_DATE_RANGE.

Allowed:

resourcePaths

array of strings | null

Specify the URL paths relative to the hostnames on which the resource resides. The path is the hostname, followed by the base path. When entering a resource path, you can use curly brackets ({}) to define path parameters (for example, /path/{pathParam}). If you decide to do so, ensure that the value of the apiParameterName member in the corresponding parameter definition matches the name that you specified in the resource path.

resourcePaths

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful response.

400Bad request. The request body has invalid fields.