@itentialopensource/adapter-akamai_property_manager

{ "openapi": "3.0.0", "info": { "title": "Property Manager API", "description": "Manage your Akamai delivery configurations with the Property Manager API.\n\nMore information on https://developer.akamai.com/api/core_features/property_manager/v1.html\n\nDon't forget to set your environment with the following variables: (the values for first 4 variables come from the API credentials you downloaded on control.akamai.com. The network can have \"staging\" or \"production\")\nhost\naccess_token\nclient_token\nclient_secret\n\nAlso two global variables should be set:\nbaseUrl which should have a value of \"https://{{host}}\"\nnetwork which should have a value of \"staging\" or \"production\"\n\nAnd additional global variable \"accountSwitchKey\" can be used by API credentials which have the permission to manage other accounts to indicate the account ID you want to manage", "contact": {}, "version": "1.0" }, "servers": [ { "url": "https://akzz-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/papi/v1", "variables": {} } ], "paths": { "/bulk/activations": { "post": { "tags": [ "activations" ], "summary": "Bulk activate a set of properties", "description": "XXX Bulk activate a set of property versions.\n(Alternately, perform a bulk [fallback](doc:fast-validation) to the previous\nactivation within an hour of the previous bulk activation.)\nBase the set of versions to activate on the results of a\n[bulk patch](https://dash.readme.com/project/papi-akamai/v1/refs/get_bulk-rules-patch-requests-bulkpatchid)\noperation, which you use to create a\n[BulkActivation](#bulkactivation) POST object.\nThis operation launches an asynchronous process to update\nproperties. To check its progress, run the\n[List bulk-activated properties](https://papi-akamai.readme.io/reference/bulkactivationsbulkactivationid#get_bulk-activations-bulkactivationid)\noperation, whose link is available in the `Location` header or\n`bulkActivationLink` member of this operation's response. See\n[Bulk Search and Update](doc:learn-about-bulk)\nfor overall guidance on this feature.\n", "operationId": "Bulkactivateasetofproperties", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkactivateasetofpropertiesRequest" }, "example": { "activatePropertyVersions": [ { "network": "STAGING", "note": "Some activation note", "propertyId": "prp_1", "propertyVersion": 2 }, { "network": "STAGING", "note": "Sample activation", "notifyEmails": [ "someoneElse@somewhere.com" ], "propertyId": "prp_15", "propertyVersion": 3 }, { "acknowledgeAllWarnings": false, "acknowledgeWarnings": [ "msg_123", "msg_234" ], "network": "PRODUCTION", "note": "created by xyz", "propertyId": "prp_3", "propertyVersion": 11 } ], "defaultActivationSettings": { "acknowledgeAllWarnings": true, "fastPush": true, "notifyEmails": [ "you@example.com", "them@example.com" ], "useFastFallback": false } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/bulk/activations/{bulkActivationId}": { "get": { "tags": [ "activations" ], "summary": "List bulk-activated properties", "description": "List all activations that result from a [bulk activation request](https://papi-akamai.readme.io/reference/bulkactivations#post_bulk-activations), and poll the asynchronous process's status. Once the overall `bulkActivationStatus` is `COMPLETE`, check each activation's `activationStatus` to confirm it's `ACTIVATED`. The response is a [BulkActivation](#bulkactivation) GET object. See [Bulk Search and Update](doc:learn-about-bulk) for overall guidance on this feature.\n", "operationId": "Listbulk-activatedproperties", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "bulkActivationId", "in": "path", "description": "(Required) Identifies each bulk activation job.", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bulkActivationId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/properties/{propertyId}/activations": { "get": { "tags": [ "activations" ], "summary": "List activations", "description": "This lists all activations for all versions of a property, on both production and staging networks.\n", "operationId": "Listactivations", "parameters": [ { "name": "contractId", "in": "query", "description": "Unique identifier for the contract.\nThe parameter is optional if the property has been\nprovisioned under only one contract.\nOtherwise you need to specify it along with the `groupId`.\n(In other operations that don't specify a `propertyId` URL\nparameter, this parameter is always required.)\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `ctr_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Unique identifier for the group.\nThe parameter is optional if the property has been\nprovisioned under only one group.\nOtherwise you need to specify it along with the `contractId`.\n(In other operations that don't specify a `propertyId` URL\nparameter, this parameter is always required.)\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `grp_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "propertyId", "in": "path", "description": "(Required) Unique identifier for the property.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `prp_` prefix.", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{propertyId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false }, "post": { "tags": [ "activations" ], "summary": "Create a new activation or deactivation", "description": "This operation creates a new property activation, which\ndeactivates any current activation. After a necessary delay,\nthis activates your property version's rule tree and set of\nhostnames across Akamai's network of edge servers, modifying how\nyour edge content responds to end-user requests.\nIf there's a problem with the property you activated, you may\nhave the option to fall back to the previous version. Within an\nhour of activating, POSTing another activation with\n`\\\"useFastFallback\\\":true` in the request object disables the\ncurrent activation and falls back to the previous version. This\nfallback takes a few seconds, but the option is available only\nif there have been no changes to the set of property hostnames,\nas indicated by the\n[`canFastFallback`](#8b3213c5)\nmember.\n\nIf the activation request produces warnings, a 400 response\nindicates this problem message: `{\"type\":\n\"/papi/v0/activation-warnings-not-acknowledged\"}`. Subsequent\nrequests succeed if you list the `messageId` values in the\nrequest's `acknowledgeWarnings` array. Once an activation is\nsuccessful, it responds with a 201 code and provides a\n`Location` header and `activationLink` in the response\nobject indicating where to poll the status of the\nactivation.\n\n> __Note__. If you set `activationType` to `DEACTIVATE` in\nthe POST request object, the property would deactivate and\nno longer serve any traffic. You'd need to modify your DNS\nconfiguration and specify a different way to handle the\ntraffic. See [Enable traffic for a new edge\nhostname](doc:enable-traffic-for-a-new-edge-hostname) for more information.\n", "operationId": "Createanewactivationordeactivation", "parameters": [ { "name": "contractId", "in": "query", "description": "Unique identifier for the contract.\nThe parameter is optional if the property has been\nprovisioned under only one contract.\nOtherwise you need to specify it along with the `groupId`.\n(In other operations that don't specify a `propertyId` URL\nparameter, this parameter is always required.)\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `ctr_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Unique identifier for the group.\nThe parameter is optional if the property has been\nprovisioned under only one group.\nOtherwise you need to specify it along with the `contractId`.\n(In other operations that don't specify a `propertyId` URL\nparameter, this parameter is always required.)\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `grp_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "propertyId", "in": "path", "description": "(Required) Unique identifier for the property.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `prp_` prefix.", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{propertyId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateanewactivationordeactivationRequest" }, "example": { "acknowledgeWarnings": [ "msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f" ], "network": "STAGING", "note": "Sample activation", "notifyEmails": [ "you@example.com", "them@example.com" ], "propertyVersion": 1, "useFastFallback": false } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/bulk/property-version-creations": { "post": { "tags": [ "property-version-creations" ], "summary": "Bulk version a set of properties", "description": "POST a [BulkVersion](#bulkversion) object to create new\nversions of a set of properties based on any previous version.\nThis operation launches an asynchronous process to increment\nversions. To check its progress,\nrun the [List bulk-versioned properties](https://papi-akamai.readme.io/reference/bulkproperty-version-creationsbulkcreateid#get_bulk-property-version-creations-bulkcreateid)\noperation, whose link is available in the `Location` header or\n`bulkCreateVersionLink` member of this operation's response.\nRun this operation only after\n[bulk searching](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) a set of properties you want\nto change, to prepare new versions to bulk patch. See\n[Bulk Search and Update](doc:learn-about-bulk)\nfor guidance on this feature.\n", "operationId": "Bulkversionasetofproperties", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkversionasetofpropertiesRequest" }, "example": { "createPropertyVersions": [ { "createFromVersion": 1, "createFromVersionEtag": "2641910c585cf67b", "propertyId": "prp_1" }, { "createFromVersion": 2, "createFromVersionEtag": "343410c585cf67fc", "propertyId": "prp_15" }, { "createFromVersion": 10, "createFromVersionEtag": "6c7v5c65c6cvcv65", "propertyId": "prp_3" } ] } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/bulk/property-version-creations/{bulkCreateId}": { "get": { "tags": [ "property-version-creations" ], "summary": "List bulk-versioned properties", "description": "List all new property versions that result from a [bulk versioning request](https://papi-akamai.readme.io/reference/bulkproperty-version-creations#post_bulk-property-version-creations), and poll the asynchronous process's status. The response is a [BulkVersion](#bulkversion) GET object. After the `bulkCreateVersionsStatus` is `COMPLETE`, use the new version numbers along with search paths from a [bulk search](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) operation to [bulk patch](https://papi-akamai.readme.io/reference/bulkrules-patch-requests#post_bulk-rules-patch-requests) them. See [Bulk Search and Update](doc:learn-about-bulk) for guidance.\n", "operationId": "Listbulk-versionedproperties", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "bulkCreateId", "in": "path", "description": "(Required) Identifies each bulk-versioning job.", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bulkCreateId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/bulk/rules-patch-requests": { "post": { "tags": [ "rules-patch-requests" ], "summary": "Bulk patch a set of properties", "description": "Apply a series of JSON Patch\noperations to modify a set of property versions. Form this set\nof `patches` based on the\n[JSONPath](http://goessner.net/articles/JsonPath/) locations\nfrom a [bulk search](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) response. Specify a set\nof new property versions based on the results of a\n[bulk versioning](https://papi-akamai.readme.io/reference/bulkproperty-version-creations#post_bulk-property-version-creations) operation. The\nrequest is a [BulkPatch](#bulkpatch) POST object. This\noperation launches an asynchronous process to update rule\ntrees. To check its progress, run the [List bulk-updated\nproperties](https://papi-akamai.readme.io/reference/bulkrules-patch-requestsbulkpatchid#get_bulk-rules-patch-requests-bulkpatchid) operation, whose link is available\nin the `Location` header or `bulkPatchLink` member of this\noperation's response. See\n[Bulk Search and Update](doc:learn-about-bulk)\nfor overall guidance on this feature.\n", "operationId": "Bulkpatchasetofproperties", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkpatchasetofpropertiesRequest" }, "example": { "patchPropertyVersions": [ { "etag": "a87v5c65c6821bc", "patches": [ { "op": "replace", "path": "/rules/children/1/features/3/option/enabled", "value": "on" }, { "op": "replace", "path": "/rules/children/1/features/0/option/enabled", "value": "on" } ], "propertyId": "prp_1", "propertyVersion": 1 }, { "etag": "6c7v5c65c6cvcv65", "patches": [ { "op": "replace", "path": "/rules/children/1/children/0/features/1/enabled", "value": "on" } ], "propertyId": "prp_15", "propertyVersion": 2 }, { "etag": "1f8903bcde2f3", "patches": [ { "op": "replace", "path": "/rules/children/0/children/1/children/2/features/1/enabled", "value": "on" } ], "propertyId": "prp_3", "propertyVersion": 10 } ] } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/bulk/rules-patch-requests/{bulkPatchId}": { "get": { "tags": [ "rules-patch-requests" ], "summary": "List bulk-patched properties", "description": "List all modified property versions that result from a [bulk patch](https://papi-akamai.readme.io/reference/bulkrules-patch-requests#post_bulk-rules-patch-requests) request, and poll the asynchronous process's status. The response is a [BulkPatch](#bulkpatch) object. Once the overall `bulkPatchStatus` is `COMPLETE`, you can feed all successfully updated property versions whose `status` is `UPDATED` into a subsequent request to [bulk activate](https://papi-akamai.readme.io/reference/bulkactivations#post_bulk-activations) them. See [Bulk Search and Update](doc:learn-about-bulk) for overall guidance on this feature.\n", "operationId": "Listbulk-patchedproperties", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "bulkPatchId", "in": "path", "description": "(Required) Identifies each bulk patch job.", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bulkPatchId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/bulk/rules-search-requests": { "post": { "tags": [ "rules-search-requests" ], "summary": "Bulk search a set of properties", "description": "POST a\n[BulkSearch](#bulksearch) object to search across all active\nproperty versions, specifying a\n[JSONPath](http://goessner.net/articles/JsonPath/) expression to\nmatch their rule trees. This operation launches an asynchronous\nprocess to gather search results. To check its progress, run the\n[List bulk search results](https://papi-akamai.readme.io/reference/bulkrules-search-requestsbulksearchid#get_bulk-rules-search-requests-bulksearchid) operation, whose link\nis available in the `Location` header or the `bulkSearchLink`\nmember of this operation's response. After gathering completed\nresults, you can create new property versions, bulk patch the\nrule trees, then activate them. See\n[Bulk Search and Update](doc:learn-about-bulk)\nfor guidance on this feature.\nRun [Synchronously bulk search a set of\nproperties](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requestssynchronus) as an alternative to\nget completed search results directly.\nTo perform simpler\nsearches for a property's name or hostnames to which it applies,\nrun the [Search properties](https://papi-akamai.readme.io/reference/searchfind-by-value#post_search-find-by-value) operation instead.\n", "operationId": "Bulksearchasetofproperties", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulksearchasetofpropertiesRequest" }, "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" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/bulk/rules-search-requests/{bulkSearchId}": { "get": { "tags": [ "rules-search-requests" ], "summary": "List bulk search results", "description": "List all property versions that result from a [bulk search request](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests). Run this operation to poll the asynchronous process's status. The response is a [BulkSearch](#bulksearch) GET object. Once the `searchTargetStatus` is `COMPLETE`, you can feed the `results` into a [bulk versioning](https://papi-akamai.readme.io/reference/bulkproperty-version-creations#post_bulk-property-version-creations) operation. Also use the JSON path `matchLocations` to run a [bulk patch](https://papi-akamai.readme.io/reference/bulkrules-patch-requests#post_bulk-rules-patch-requests) operation over the rule trees. See [Bulk Search and Update](doc:learn-about-bulk) for guidance.\n", "operationId": "Listbulksearchresults", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "bulkSearchId", "in": "path", "description": "(Required) Identifies each bulk search job.", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bulkSearchId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/bulk/rules-search-requests-synch": { "post": { "tags": [ "bulk" ], "summary": "Synchronously bulk search a set of properties", "description": "Provides an alternative to the asynchronous [Bulk search a set of\nproperties](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) operation. It yields completed\nbulk search results directly, but with possibly high latency,\nmaking it more appropriate to target for small-batch searches.\nPOST a [BulkSearch](#bulksearch) object to search across all\nactive property versions, specifying a\n[JSONPath](http://goessner.net/articles/JsonPath/) expression to\nmatch their rule trees. After gathering results, you can create\nnew property versions, bulk patch the rule trees, then activate\nthem. See [Bulk Search and Update](doc:learn-about-bulk) for\nguidance on this feature.\nTo perform simpler searches for a property's name or hostnames\nto which it applies, run the [Search\nproperties](https://papi-akamai.readme.io/reference/searchfind-by-value#post_search-find-by-value) operation instead.\n", "operationId": "Synchronouslybulksearchasetofproperties", "parameters": [ { "name": "contractId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from each\nother.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronouslybulksearchasetofpropertiesRequest" }, "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" } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/client-settings": { "get": { "tags": [ "client-settings" ], "summary": "Get client settings", "description": "Get the current set of default values that apply to API clients keyed by the current authorization token.\n", "operationId": "Getclientsettings", "parameters": [], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false }, "put": { "tags": [ "client-settings" ], "summary": "Update client settings", "description": "Update the current set of default values\nthat apply to API clients keyed by the current authorization\ntoken.\n", "operationId": "Updateclientsettings", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateclientsettingsRequest" }, "example": { "ruleFormat": "v2015-08-08", "usePrefixes": true } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/cpcodes": { "get": { "tags": [ "cpcodes" ], "summary": "List CP codes", "description": "This operation lists CP codes available within your contract and group pairing, which you assign to a property within its rule tree. CP codes include information about the product under which they were generated. When [creating a new property](https://papi-akamai.readme.io/reference/properties#post_properties), you should apply the same product under which the associated CP code was created.\n", "operationId": "ListCPcodes", "parameters": [ { "name": "contractId", "in": "query", "description": "(Required) Unique identifier for the contract.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `ctr_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "(Required) Unique identifier for the group.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `grp_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false }, "post": { "tags": [ "cpcodes" ], "summary": "Create a new CP code", "description": "To create a new CP code, you need to\nassociate it with a product. You can assign any CP code within\na property's rule tree as detailed in the\n[Rule Trees](doc:rule-trees)\nsection. You should match the same `productId` that's assigned\nto properties that invoke the CP code to the one assigned to the\nCP code, otherwise you may get a warning.\n", "operationId": "CreateanewCPcode", "parameters": [ { "name": "contractId", "in": "query", "description": "(Required) Unique identifier for the contract.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `ctr_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "(Required) Unique identifier for the group.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `grp_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{groupId}}" } }, { "name": "PAPI-Use-Prefixes", "in": "header", "description": "(Required) Sets whether to display three-letter prefixes in various ID values in response data. This may override the client's default `usePrefixes` setting. See [ID Prefixes](doc:id-prefixes).", "required": true, "style": "simple", "schema": { "type": "string", "example": "adipisicing anim et pariatur" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateanewCPcodeRequest" }, "example": { "cpcodeName": "SME WAA", "productId": "prd_Web_App_Accel" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false } }, "/cpcodes/{cpcodeId}": { "get": { "tags": [ "cpcodes" ], "summary": "Get a CP code", "description": "This operation gets details about a CP code.\n", "operationId": "GetaCPcode", "parameters": [ { "name": "contractId", "in": "query", "description": "(Required) Unique identifier for the contract.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `ctr_` prefix.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "{{contractId}}" } }, { "name": "groupId", "in": "query", "description": "(Required) Unique identifier for the group.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `grp_` prefix.", "required": true, "style": "form", "explode"