--- updatedAt: 2026-03-01T18:49:45.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/property-mgr/llms.txt --- # Bulk search a set of properties or includes POST a bulk search object to search across all active property or include versions. Specify a [JSONPath](http://goessner.net/articles/JsonPath/) expression to match their rule trees. This operation launches an asynchronous process to gather search results. To check its progress, run the [List bulk search results](ref:get-bulk-search) operation, whose link is available in the `Location` header or the `bulkSearchLink` member of this operation's response. After gathering completed results, you can create new property versions, bulk patch the rule trees, then activate them. See [Bulk Search and Update](ref:bulk-search-and-update) for guidance on this feature. Run [Synchronously bulk search a set of properties](ref:post-bulk-searchsynchronus) as an alternative to get completed search results directly. To perform simpler searches for an include's name or property's name or hostnames to which it applies, run the [Search properties and includes](ref:post-search-find-by-value) operation instead. # OpenAPI definition ```json { "externalDocs": { "description": "See documentation for Akamai's Property Manager API", "url": "https://techdocs.akamai.com/property-mgr/reference" }, "info": { "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Bulk search and update", "version": "v0" }, "openapi": "3.1.0", "paths": { "/bulk/rules-search-requests": { "post": { "description": "POST a bulk search object to search across all active property or include versions. Specify a [JSONPath](http://goessner.net/articles/JsonPath/) expression to match their rule trees. This operation launches an asynchronous process to gather search results. To check its progress, run the [List bulk search results](https://techdocs.akamai.com/property-mgr/reference/get-bulk-search) operation, whose link is available in the `Location` header or the `bulkSearchLink` member of this operation's response. After gathering completed results, you can create new property versions, bulk patch the rule trees, then activate them. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on this feature. Run [Synchronously bulk search a set of properties](https://techdocs.akamai.com/property-mgr/reference/post-bulk-searchsynchronus) as an alternative to get completed search results directly. To perform simpler searches for an include's name or property's name or hostnames to which it applies, run the [Search properties and includes](https://techdocs.akamai.com/property-mgr/reference/post-search-find-by-value) operation instead.", "externalDocs": { "description": "See documentation for this operation in Akamai's Property Manager API", "url": "https://techdocs.akamai.com/property-mgr/reference/post-bulk-search" }, "operationId": "post-bulk-search", "parameters": [ { "description": "__Enum__ Sets whether to represent [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/id-prefixes) in response data. Set to `false` when exchanging PAPI data with other APIs.", "in": "header", "name": "PAPI-Use-Prefixes", "required": true, "schema": { "enum": [ "true", "false" ], "example": "false", "type": "string" }, "x-akamai": { "file-path": "parameters/papi-use-prefixes-header.yaml" } }, { "description": "Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify `contractId` and `groupId` independently from each other.", "in": "query", "name": "contractId", "required": false, "schema": { "example": "ctr_K-0N7RAK71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-optional-bulk.yaml" } }, { "description": "Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify `contractId` and `groupId` independently from each other.", "in": "query", "name": "groupId", "required": false, "schema": { "example": "grp_12345", "type": "string" }, "x-akamai": { "file-path": "parameters/group-id-optional-bulk.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "bulkSearchQuery": { "bulkSearchQualifiers": [ "$.options[?(@.secure==\"true\")]", "$..features[?(@.name==\"origin\")].options[?(@.hostname==\"old.origin.example.com\")]" ], "match": "$..conditions[?(@.name == \"ext\" && \"mp3\" in @.options.value && \"mp4\" nin @.options.value)].options.value[?(@ == \"mp3\")]", "syntax": "JSONPATH" } }, "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "A bulk search job. The request specifies JSONPath search queries, and the response includes JSON path locations within matching rule trees. Check the `searchTargetStatus` of potentially long-running asynchronous jobs for when they're `COMPLETE`. See [Bulk Search and Update](https://techdocs.akamai.com/property-mgr/reference/bulk-search-and-update) for guidance on how to use this object.", "existingJavaType": "com.akamai.devops.model.BulkSearchRequest", "id": "resource:/descriptors/papi/v1/schemas/CreateNewBulkSearchRequestV0.json#", "properties": { "bulkSearchQuery": { "description": "Specifies the set of bulk search criteria.", "properties": { "bulkSearchQualifiers": { "description": "An additional set of JSON Path test expressions that must all succeed for the main `match` on the rule tree to yield results.", "items": { "type": "string" }, "type": "array" }, "match": { "description": "The JSON Path expression to search within available rule trees.", "type": "string" }, "syntax": { "description": "Identifies the query syntax for the search. The only currently supported syntax system is `JSONPATH`.", "enum": [ "JSONPATH" ], "type": "string" } }, "required": [ "syntax", "match" ] }, "propertyType": { "description": "Specifies the type of the property, either `TRADITIONAL`, `INCLUDE`, or `HOSTNAME_BUCKET`.", "enum": [ "TRADITIONAL", "HOSTNAME_BUCKET", "INCLUDE" ], "type": "string" } }, "required": [ "bulkSearchQuery" ], "type": "object", "x-akamai": { "file-path": "schemas/bulk-search-create-request.yaml" } } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "bulkSearchLink": "/papi/v0/bulk/rules-search-requests/737" }, "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "description": "Provides a hypermedia link to a newly created resource. The response's single member name indicates the type of resource.", "existingJavaType": "com.akamai.devops.model.BulkSearchResponse", "id": "resource:/descriptors/papi/v1/schemas/PostBulkSearchResponse.json", "properties": { "bulkSearchLink": { "description": "Links the newly created bulk search process.", "type": "string" } }, "required": [ "bulkSearchLink" ], "type": "object", "x-akamai": { "file-path": "schemas/bulk-search-post-response.yaml" } } } }, "description": "The response links the bulk search process.", "headers": { "Location": { "description": "Provides a URL path you can GET the newly created resource from.", "schema": { "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } }, "X-RateLimit-Limit": { "description": "Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the [429](https://techdocs.akamai.com/property-mgr/reference/429) error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.\n\nThis API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.", "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/x-rate-limit-limit.yaml" } }, "X-RateLimit-Remaining": { "description": "Remaining number of requests allowed each minute per account. See [Rate and resource limiting](https://techdocs.akamai.com/property-mgr/reference/rate-and-resource-limiting) for details.", "schema": { "type": "integer" }, "x-akamai": { "file-path": "headers/x-rate-limit-remaining.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "The system cannot understand your request. Please check the syntax and correct any problems.", "instance": "/papi/v1/properties?contractId=ctr_K-0N7RAK71&groupId=grp_12345#abc12345abcc02a7", "status": 400, "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/papi/v0/http/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/property-mgr/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC71&groupId=grp_12345#abc12345abcc02a7", "status": 401, "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/papi/v0/http/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/property-mgr/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "The authorization token you provided does not allow access to this resource.", "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC71&groupId=grp_12345#abc12345abcc02a7", "status": 403, "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/property-mgr/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "The system was unable to locate the requested resource.", "instance": "/papi/v1/properties?contractId=ctr_K-0N7RAK7&groupId=grp_12345#abc12345abcc02a7", "status": 404, "title": "Not Found", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/not-found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/property-mgr/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "content": { "application/problem+json": { "example": { "detail": "The system does not support the method you provided for this resource.", "instance": "/papi/v1/properties?contractId=ctr_C-0N7RAC71&groupId=grp_12345#abc12345abcc02a7", "status": 405, "title": "Method not allowed", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/method-not-allowed" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Method not allowed](https://techdocs.akamai.com/property-mgr/reference/405).", "x-akamai": { "file-path": "errors/405.yaml" } }, "406": { "content": { "application/problem+json": { "example": { "detail": "The system does not support the content-type restrictions provided by your 'Accept' header.", "instance": "papi/v1/build#abc12345abcc02a7", "status": 406, "title": "Not Acceptable", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/not-acceptable" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not acceptable](https://techdocs.akamai.com/property-mgr/reference/406).", "x-akamai": { "file-path": "errors/406.yaml" } }, "415": { "content": { "application/problem+json": { "example": { "detail": "Our system does not support requests in the format you're sending.", "instance": "/papi/v1/properties?contractId=ctr_K-0N7RAK71&groupId=grp_12345#abc12345abcc02a7", "status": 415, "title": "Unsupported Media Type", "type": "https://problems.luna.akamaiapis.net/papi/v1/http/unsupported-media-type" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unsupported media type](https://techdocs.akamai.com/property-mgr/reference/415).", "x-akamai": { "file-path": "errors/415.yaml" } }, "429": { "content": { "application/problem+json": { "example": { "detail": "Too many includes exist on contract ctr_1-12345. You must delete an include before continuing.", "instance": "/papi/v1/includes?contractId=ctr_K-0N7RAK7&groupId=grp_12345#abc12345abcc02a7", "instanceKey": "1-12345", "limit": 500, "limitKey": "INCLUDES_PER_CONTRACT", "remaining": 0, "status": 429, "title": "Too many includes", "type": "https://problems.luna.akamaiapis.net/papi/v1/limit-exceeded" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "instanceKey": { "description": "Identifies the resource the limit is imposed on.", "minLength": 1, "type": "string" }, "limit": { "description": "The overall limit.", "type": "integer" }, "limitKey": { "description": "The limit that got exceeded with the operation.", "minLength": 1, "type": "string" }, "remaining": { "description": "Number of items left to deploy.", "type": "integer" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance", "limitKey", "instanceKey", "limit", "remaining" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-429.yaml" } } } }, "description": "[Too many requests](https://techdocs.akamai.com/property-mgr/reference/429).", "x-akamai": { "file-path": "errors/429.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Our system is experiencing errors. We''ll get this fixed as soon as possible.", "instance": "/papi/v1/properties/12345/activations#abc12345abcc02a7", "status": 500, "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/papi/proxy/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 7807](https://www.rfc-editor.org/rfc/rfc7807) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "format": "uri", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/property-mgr/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Bulk search a set of properties or includes", "tags": [ "Bulk search" ] }, "x-akamai": { "file-path": "paths/bulk-searches.yaml", "path-for-file": "/bulk/rules-search-requests" }, "x-akamai-descriptor-tools": { "displayName": "bulkSearches", "group": "Bulk searches" } } }, "servers": [ { "url": "https://{hostname}/papi/v1" } ], "x-akamai": { "auth-type": "EDGE_GRID", "file-path": "06-bulk.yaml" }, "x-readme": { "samples-languages": [ "curl", "python", "node" ], "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [Synchronously bulk search a set of properties or includes](https://techdocs.akamai.com/property-mgr/reference/post-bulk-search-synch.md) * [List bulk search results](https://techdocs.akamai.com/property-mgr/reference/get-bulk-search.md)