{
"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": true,
"schema": {
"type": "string",
"example": "{{groupId}}"
}
},
{
"name": "cpcodeId",
"in": "path",
"description": "(Required) Unique identifier for the CP code.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `cpc_` prefix.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{cpcodeId}}"
}
},
{
"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
}
},
"/custom-behaviors/{behaviorId}": {
"delete": {
"tags": [
"{behavior Id}"
],
"summary": "Delete a custom behavior",
"description": "Update status to DELETED. Operation\nis Akamai-internal.\n",
"operationId": "Deleteacustombehavior",
"parameters": [
{
"name": "behaviorId",
"in": "path",
"description": "(Required) Unique identifier for the custom behavior.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{behaviorId}}"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
},
"get": {
"tags": [
"{behavior Id}"
],
"summary": "Get a custom behavior",
"description": "Get information for a single custom behavior. Use this operation if you want to examine the custom behavior's XML metadata source.\n",
"operationId": "Getacustombehavior",
"parameters": [
{
"name": "behaviorId",
"in": "path",
"description": "(Required) Unique identifier for the custom behavior.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{behaviorId}}"
}
},
{
"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
},
"put": {
"tags": [
"{behavior Id}"
],
"summary": "Lock a custom behavior",
"description": "updating status to 'LOCKED'. Operation\nis Akamai-internal.\n",
"operationId": "Lockacustombehavior",
"parameters": [
{
"name": "lock",
"in": "query",
"description": "Lock custom behavior when 'true'.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "behaviorId",
"in": "path",
"description": "(Required) Unique identifier for the custom behavior.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{behaviorId}}"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string",
"example": "\"adipisicing anim et pariatur\""
},
"example": "\"adipisicing anim et pariatur\""
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/custom-behaviors": {
"get": {
"tags": [
"custom-behaviors"
],
"summary": "List custom behaviors",
"description": "Lists the set of custom XML metadata behaviors configured for you by Akamai representatives. Referencing the relevant `behaviorId` from a [`customBehavior`](http://learn.akamai.com/en-us/api/core_features/property_manager/vlatest.html#custombehavior) within the rule tree injects the custom XML within the rest of the rule tree's metadata XML. See [Custom behaviors and overrides](doc:custom-behaviors-and-overrides) for guidance on custom overrides.\n",
"operationId": "Listcustombehaviors",
"parameters": [
{
"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": [
"custom-behaviors"
],
"summary": "Create a new custom behavior",
"description": "Operation is Akamai-internal.\n",
"operationId": "Createanewcustombehavior",
"parameters": [
{
"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/CreateanewcustombehaviorRequest"
},
"example": {
"approvedByUser": "jlandis",
"description": "MDC Behavior\n",
"displayName": "Multiple Domain Configuration",
"name": "mdc",
"sharingLevel": "ACCOUNT",
"xml": "This is where the Metadata goes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/custom-overrides/{overrideId}": {
"delete": {
"tags": [
"{override Id}"
],
"summary": "Delete a custom override",
"description": "Operation is Akamai-internal.\n",
"operationId": "Deleteacustomoverride",
"parameters": [
{
"name": "overrideId",
"in": "path",
"description": "(Required) Unique identifier for the custom override.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{overrideId}}"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
},
"get": {
"tags": [
"{override Id}"
],
"summary": "Get a custom override",
"description": "Get information for a single custom override. Use this operation if you want to examine the override's XML metadata.\n",
"operationId": "Getacustomoverride",
"parameters": [
{
"name": "overrideId",
"in": "path",
"description": "(Required) Unique identifier for the custom override.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{overrideId}}"
}
},
{
"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
},
"put": {
"tags": [
"{override Id}"
],
"summary": "Lock a custom override",
"description": "Update status to 'LOCKED'. Operation is Akamai-internal.\n",
"operationId": "Lockacustomoverride",
"parameters": [
{
"name": "lock",
"in": "query",
"description": "Lock custom override when 'true'.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "overrideId",
"in": "path",
"description": "(Required) Unique identifier for the custom override.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{overrideId}}"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string",
"example": "\"adipisicing anim et pariatur\""
},
"example": "\"adipisicing anim et pariatur\""
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/custom-overrides": {
"get": {
"tags": [
"custom-overrides"
],
"summary": "List custom overrides",
"description": "Lists the set of custom XML metadata overrides configured for you by Akamai representatives. Referencing the relevant `overrideId` from a [Rule.customOverride](#efe4941f) object makes the custom XML append to the rest of the metadata XML defined by the rule tree, typically to restore state. See [Custom behaviors and overrides](doc:custom-behaviors-and-overrides) for guidance on custom overrides.\n",
"operationId": "Listcustomoverrides",
"parameters": [
{
"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": [
"custom-overrides"
],
"summary": "Create a new custom override",
"description": "Operation is Akamai-internal.\n",
"operationId": "Createanewcustomoverride",
"parameters": [
{
"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/CreateanewcustomoverrideRequest"
},
"example": {
"approvedByUser": "jlandis",
"description": "MDC Behavior\n",
"displayName": "Multiple Domain Configuration",
"name": "mdc",
"sharingLevel": "ACCOUNT",
"xml": "This is where the Metadata goes"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/edgehostnames": {
"get": {
"tags": [
"edgehostnames"
],
"summary": "List edge hostnames",
"description": "This lists all edge hostnames available under a contract. To assign any of these hostnames to a property, run [Update a property's hostnames](https://papi-akamai.readme.io/reference/propertiespropertyidversionspropertyversionhostnames#put_properties-propertyid-versions-propertyversion-hostnames). Use the [Edge Hostname API](https://developer.akamai.com/api/core_features/edge_hostnames/v1.html#getcertificatefortheedgehostname) (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration.\n",
"operationId": "Listedgehostnames",
"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": "options",
"in": "query",
"description": "Comma-separated list of options to enable; `mapDetails`\nenables extra mapping-related information.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "{{options}}"
}
},
{
"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": [
"edgehostnames"
],
"summary": "Create a new edge hostname",
"description": "This operation creates a new edge hostname. As detailed in the sections below, you can use three approaches to secure new edge hostnames: [Standard TLS](doc:standard-tls-edge-hostname), [Enhanced TLS](doc:enhanced-tls-edge-hostname), or a [Shared Certificate](doc:shared-certificate-edge-hostname). You can [assign a use case](doc:assign-a-use-case-to-an-edge-hostname) mapping profile to optimize the hostname to serve specific types of traffic. For more information, see [Create edge hostnames using PAPI](http://learn.akamai.com/en-us/api/learn_akamai/getting_started_with_akamai_developers/core_features/create_edgehostnames.html). Once the hostname is active, you can [Update a property's hostnames](https://papi-akamai.readme.io/reference/propertiespropertyidversionspropertyversionhostnames#put_properties-propertyid-versions-propertyversion-hostnames) to assign it to a property. After you [activate a property](https://papi-akamai.readme.io/reference/propertiespropertyidactivations#post_properties-propertyid-activations), modifying your DNS to map the origin hostname to the edge hostname ultimately enables traffic on the property. For details, see [Enable traffic for a new edge hostname](doc:enable-traffic-for-a-new-edge-hostname). Use the [Edge Hostname API](https://developer.akamai.com/api/core_features/edge_hostnames/v1.html#getcertificatefortheedgehostname) (HAPI) to modify edge hostnames, or delete any that aren't currently assigned to an active property configuration.\n",
"operationId": "Createanewedgehostname",
"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": "options",
"in": "query",
"description": "Comma-separated list of options to enable; `mapDetails`\nenables extra mapping-related information.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "{{options}}"
}
},
{
"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/CreateanewedgehostnameRequest"
},
"example": {
"domainPrefix": "www.example.com",
"domainSuffix": "edgesuite.net",
"ipVersionBehavior": "IPV4",
"productId": "prd_Dynamic_Site_Del",
"secureNetwork": "STANDARD_TLS",
"useCases": [
{
"option": "BACKGROUND",
"type": "GLOBAL",
"useCase": "Download_Mode"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/edgehostnames/{edgeHostnameId}": {
"get": {
"tags": [
"edgehostnames"
],
"summary": "Get an edge hostname",
"description": "This polls the state of an edge hostname, typically after [creating a new edge hostname](https://papi-akamai.readme.io/reference/edgehostnames#post_edgehostnames). The response tells you whether the CNAME has been fully distributed across the network. If the hostname's `status` is `ACTIVE`, the process is complete. Until then, you typically see values of `ZONE1`, `ZONE2`, `ZONE3`, or simply `PENDING`.\n",
"operationId": "Getanedgehostname",
"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": "options",
"in": "query",
"description": "Comma-separated list of options to enable; `mapDetails`\nenables extra mapping-related information.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "{{options}}"
}
},
{
"name": "edgeHostnameId",
"in": "path",
"description": "(Required) Unique identifier for the edge hostname.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `ehn_` prefix.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{edgeHostnameId}}"
}
},
{
"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
}
},
"/products": {
"get": {
"tags": [
"products"
],
"summary": "List products",
"description": "This operation lists the set of products that are available under a given contract. You need a product identifier to create new edge hostnames, CP codes, or properties. The range of rule behaviors available within a property is determined by the assigned product.\n",
"operationId": "Listproducts",
"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": "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
}
},
"/products/{productId}/mapping-use-cases": {
"get": {
"tags": [
"products"
],
"summary": "List use cases",
"description": "For a given product, this lists Akamai-provided use case scenarios that help optimally map different types of traffic across the Akamai edge network. Optionally run this operation to gather values before [creating a new edge hostname](https://papi-akamai.readme.io/reference/edgehostnames#post_edgehostnames).\n",
"operationId": "Listusecases",
"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": "productId",
"in": "path",
"description": "(Required) Unique identifier for the product.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `prd_` prefix.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{productId}}"
}
},
{
"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/{activationId}": {
"delete": {
"tags": [
"{activation Id}"
],
"summary": "Cancel a pending activation",
"description": "If you detect a problem with a property version while its\nactivation is still `PENDING`, this operation allows you to\ncancel it. Make a DELETE request on the response's\n`activationLink` from running [Activate a\nproperty](https://papi-akamai.readme.io/reference/propertiespropertyidactivations#post_properties-propertyid-activations). Once you DELETE the\nactivation, it no longer appears in the [list of\nactivations](https://papi-akamai.readme.io/reference-link/get_properties-propertyid-activations), but you can still\n[access it individually](https://papi-akamai.readme.io/reference/propertiespropertyidactivationsactivationid#get_properties-propertyid-activations-activationid). If there\nare unexpected problems with an activation that goes live\nbefore you're able to cancel it, you often have a one-hour\nwindow to quickly fall back to a previous activation. See\n[Create a new activation or\ndeactivation](https://papi-akamai.readme.io/reference/propertiespropertyidactivations#post_properties-propertyid-activations) for details.\n\nA successful cancellation results in a 200 response and an\n`ABORTED` status. If the activation is no longer `PENDING`,\na 422 (unprocessable) error indicates that it can no longer\nbe canceled. Canceling an activation that has already been\ncanceled results in a 204 response, indicating there's no\nresource to delete. Canceling an unknown activation results\nin a 404 error.\n\nYou can only abort an activation while it's queued for\ndeployment across the various network zones with `PENDING`\nstatus. Once the window has closed and it's been dispatched\nacross the network, you can either [reactivate an older\nversion](https://papi-akamai.readme.io/reference/propertiespropertyidactivations#post_properties-propertyid-activations), or [create a new\nversion](https://papi-akamai.readme.io/reference/propertiespropertyidversions#post_properties-propertyid-versions) that fixes the problem and\nactivate that instead.\n",
"operationId": "Cancelapendingactivation",
"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": "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": "activationId",
"in": "path",
"description": "(Required) Unique identifier for the activation.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{activationId}}"
}
},
{
"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
},
"get": {
"tags": [
"{activation Id}"
],
"summary": "Get an activation",
"description": "Gets details about an activation. You typically get a single activation from an `activationLink` when [launching a new activation](https://papi-akamai.readme.io/reference/propertiespropertyidactivations#post_properties-propertyid-activations) and following up to poll its `status`. For activations whose `status` is `PENDING`, a `Retry-After` header provides an estimate for when it's likely to change.\n",
"operationId": "Getanactivation",
"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": "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": "activationId",
"in": "path",
"description": "(Required) Unique identifier for the activation.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{activationId}}"
}
},
{
"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}/versions/{propertyVersion}/hostnames": {
"get": {
"tags": [
"hostnames"
],
"summary": "List a property's hostnames",
"description": "This lists all the hostnames assigned to a property version, which may be a subset of [all available edge hostnames](https://papi-akamai.readme.io/reference/edgehostnames#get_edgehostnames).\n",
"operationId": "Listaproperty'shostnames",
"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": "validateHostnames",
"in": "query",
"description": "When `false` (the default), skips validation tests that\nwould identify potential hostname-related problems within\nthe response object's `errors` and `warnings` arrays. See\n[Property hostname errors](doc:property-hostname-errors)\nfor details on relevant error feedback. See\n[Fast validation, activation, and fallback](doc:fast-validation)\nfor details on the delays this might avoid.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"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": "propertyVersion",
"in": "path",
"description": "(Required) Property's incremental version number.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{propertyVersion}}"
}
},
{
"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
},
"put": {
"tags": [
"hostnames"
],
"summary": "Update a property's hostnames",
"description": "Modify the set of hostname entries for a property version. For\neach hostname entry, specify a `cnameFrom` along with either a\n`cnameTo` or `edgeHostnameId`.\nIf you remove a hostname from an active property configuration,\nyou can then reassign it to another property, or use the\n[Edge Hostname API](https://developer.akamai.com/api/core_features/edge_hostnames/v1.html#getcertificatefortheedgehostname)\n(HAPI) to delete the edge hostname.\n\nThere are no POST or DELETE operations to add or remove\nhostnames from a property, so to assign them you need to\nmake a PUT request that specifies the entire set as an\narray. Since the data sent in the PUT request is an array,\nadding an `If-Match` HTTP header is the only way to prevent\noverwriting edits from another client. See [Concurrency\ncontrol](doc:concurrency-control) for more information on this\ntechnique.\n\nIf you activate a property version that specifies a hostname\nalready active on another property, it's removed from that\nproperty, and a new property version is automatically\ncreated and activated with the change. Otherwise you don't\nreceive any warning when saving a set of overlapping\nhostnames on an inactive version.\n\nSet the `validateHostnames` query parameter to `false` to\nbypass a set of validation tests that may significantly slow\nthis operation's execution time. See [Fast validation,\nactivation, and fallback](doc:fast-validation) for guidance on when to\ndefer validation. See [JSON problems](doc:json-problem-responses) for\ninformation on how validation data is embedded within the\nresponse object.\n",
"operationId": "Updateaproperty'shostnames",
"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": "validateHostnames",
"in": "query",
"description": "When `false` (the default), skips validation tests that\nwould identify potential hostname-related problems within\nthe response object's `errors` and `warnings` arrays. See\n[Property hostname errors](doc:property-hostname-errors)\nfor details on relevant error feedback. See\n[Fast validation, activation, and fallback](doc:fast-validation)\nfor details on the delays this might avoid.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"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": "propertyVersion",
"in": "path",
"description": "(Required) Property's incremental version number.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{propertyVersion}}"
}
},
{
"name": "If-Match",
"in": "header",
"description": "(Required)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "adipisicing anim et pariatur"
}
},
{
"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": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateapropertyshostnamesRequest"
},
"description": "",
"example": [
{
"cnameFrom": "m.example.com",
"cnameTo": "example.com.edgesuite.net",
"cnameType": "EDGE_HOSTNAME"
},
{
"cnameFrom": "example3.com",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895824"
}
]
},
"example": [
{
"cnameFrom": "m.example.com",
"cnameTo": "example.com.edgesuite.net",
"cnameType": "EDGE_HOSTNAME"
},
{
"cnameFrom": "example3.com",
"cnameType": "EDGE_HOSTNAME",
"edgeHostnameId": "ehn_895824"
}
]
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/properties/{propertyId}/versions/{propertyVersion}/rules": {
"get": {
"tags": [
"rules"
],
"summary": "Get a rule tree",
"description": "This gets the entire rule tree for a property version. See the [Rule Trees](doc:rule-trees) section for details on the response object's structure. Also use this operation to update from one rule format to another more recent version, incrementing the assigned set of features. See [Update rules to a newer set of features](doc:update-rules-to-a-newer-set-of-features).\n",
"operationId": "Getaruletree",
"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": "validateRules",
"in": "query",
"description": "Set to `true` by default. When `false`, skips validation\ntests that would identify potential problems within the\nresponse object's `errors` and `warnings` arrays. See the\n[JSON problems](doc:json-problem-responses)\nsection for details on this error feedback. See\n[Fast validation, activation, and fallback](doc:fast-validation)\nfor details on the delays this might avoid.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "validateMode",
"in": "query",
"description": "With `validateRules` enabled, setting this to `fast`\nperforms a quick validation check based on the provided\nJSON. This is faster than the default `full` validation,\nwhich performs more extensive checks on the converted XML\nmetadata configuration.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "full"
}
},
{
"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": "propertyVersion",
"in": "path",
"description": "(Required) Property's incremental version number.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{propertyVersion}}"
}
},
{
"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
},
"patch": {
"tags": [
"rules"
],
"summary": "Patch a rule tree",
"description": "Selectively modify a rule tree using [JSON\npatch](http://jsonpatch.com) syntax. As a component of the\nlarger [Bulk patch a set of properties](https://papi-akamai.readme.io/reference/bulkrules-patch-requests#post_bulk-rules-patch-requests), this\noperation patches an individual rule tree. See [Bulk Search\nand Update](doc:learn-about-bulk) for more information.\nTo bypass a set of validation tests that may significantly\nslow this operation's execution time, set the `validateRules`\nquery parameter to `false` or `validateMode` to `fast`. See\n[Fast validation, activation, and fallback](doc:fast-validation) for more\ninformation.\n",
"operationId": "Patcharuletree",
"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": "validateRules",
"in": "query",
"description": "Set to `true` by default. When `false`, skips validation\ntests that would identify potential problems within the\nresponse object's `errors` and `warnings` arrays. See the\n[JSON problems](doc:json-problem-responses)\nsection for details on this error feedback. See\n[Fast validation, activation, and fallback](doc:fast-validation)\nfor details on the delays this might avoid.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "validateMode",
"in": "query",
"description": "With `validateRules` enabled, setting this to `fast`\nperforms a quick validation check based on the provided\nJSON. This is faster than the default `full` validation,\nwhich performs more extensive checks on the converted XML\nmetadata configuration.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "full"
}
},
{
"name": "dryRun",
"in": "query",
"description": "With `validateRules` also enabled, allows for a _dry run_ in\norder to gather any possible errors without saving the rule\ntree.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
{
"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": "propertyVersion",
"in": "path",
"description": "(Required) Property's incremental version number.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{propertyVersion}}"
}
},
{
"name": "If-Match",
"in": "header",
"description": "(Required)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "adipisicing anim et pariatur"
}
},
{
"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-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PatcharuletreeRequest"
},
"description": "",
"example": [
{
"op": "replace",
"path": "/rules/options/is_secure",
"value": true
},
{
"op": "replace",
"path": "/rules/children/0/name",
"value": "Handle /my-path"
}
]
},
"example": [
{
"op": "replace",
"path": "/rules/options/is_secure",
"value": true
},
{
"op": "replace",
"path": "/rules/children/0/name",
"value": "Handle /my-path"
}
]
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
},
"put": {
"tags": [
"rules"
],
"summary": "Update a rule tree",
"description": "To write a rule tree to a property version, make a PUT request\nto the same resource as the GET request that reads it, passing\nin the rule object in the body of the request. See the\n[Rule Trees](doc:rule-trees)\nsection for details on the rule tree's structure. Use this\noperation also to\n[freeze a set of rules](doc:freeze-a-rule-trees-feature-set)\nto a rule format version to ensure no change in a deployed\nactivation's behavior. Set the `validateRules` query parameter\nto `false` to bypass a set of validation tests that may\nsignificantly slow this operation's execution time. See\n[Fast validation and activation](doc:fast-validation)\nfor guidance on when to defer validation. See\n[JSON problems](doc:json-problem-responses)\nfor information on how validation data is embedded within the\nresponse object.\n",
"operationId": "Updatearuletree",
"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": "validateRules",
"in": "query",
"description": "Set to `true` by default. When `false`, skips validation\ntests that would identify potential problems within the\nresponse object's `errors` and `warnings` arrays. See the\n[JSON problems](doc:json-problem-responses)\nsection for details on this error feedback. See\n[Fast validation, activation, and fallback](doc:fast-validation)\nfor details on the delays this might avoid.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "validateMode",
"in": "query",
"description": "With `validateRules` enabled, setting this to `fast`\nperforms a quick validation check based on the provided\nJSON. This is faster than the default `full` validation,\nwhich performs more extensive checks on the converted XML\nmetadata configuration.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "full"
}
},
{
"name": "dryRun",
"in": "query",
"description": "With `validateRules` also enabled, allows for a _dry run_ in\norder to gather any possible errors without saving the rule\ntree.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
{
"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": "propertyVersion",
"in": "path",
"description": "(Required) Property's incremental version number.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{propertyVersion}}"
}
},
{
"name": "If-Match",
"in": "header",
"description": "(Required)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "adipisicing anim et pariatur"
}
},
{
"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/UpdatearuletreeRequest"
},
"example": {
"rules": {
"children": [
{
"behaviors": [
{
"behavior": "max-age",
"name": "caching",
"ttl": "1m"
}
],
"criteria": [
{
"name": "path",
"value": [
"/my-path"
]
}
],
"criteriaMustSatisfy": "all",
"name": "Handle /my-path"
}
],
"name": "default"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/properties/{propertyId}/versions/{propertyVersion}": {
"get": {
"tags": [
"{property Version}"
],
"summary": "Get a version",
"description": "This polls the state of a specific property version, for example to check its activation status. When specifying `Accept: text/xml`, this operation provides the Akamai _metadata_ configuration data that's distributed to edge servers when the property version is activated. This XML data encapsulates the property version's component rules and hostnames, and is available on a read-only basis. Contact your Akamai representative if you need help interpreting it.\n",
"operationId": "Getaversion",
"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": "propertyVersion",
"in": "path",
"description": "(Required) Property's incremental version number.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{propertyVersion}}"
}
},
{
"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}/versions/{propertyVersion}/available-behaviors": {
"get": {
"tags": [
"{property Version}"
],
"summary": "List available behaviors",
"description": "Lists the set of [behaviors](http://learn.akamai.com/en-us/api/core_features/property_manager/vlatest.html#behaviors) you may apply within a property version's rules. The available set is determined by the product under which you created the property, and any additional modules enabled under your account.\n\nNote that this list of available behaviors is more accurate than that specified in the [rule format schema](https://papi-akamai.readme.io/reference/schemasproductsproductidruleformat#get_schemas-products-productid-ruleformat), which includes behaviors you may potentially add to your contract for a given product, but that aren't currently active. However, it only lists behaviors _currently_ available on your contract, so you should only use it to list available behaviors for the current property version. If you had a behavior enabled at one time, but then dropped it from your contract, a list of available behaviors for an older property version might be inaccurate.\n",
"operationId": "Listavailablebehaviors",
"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": "propertyVersion",
"in": "path",
"description": "(Required) Property's incremental version number.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{propertyVersion}}"
}
},
{
"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}/versions/{propertyVersion}/available-criteria": {
"get": {
"tags": [
"{property Version}"
],
"summary": "List available criteria",
"description": "Lists the set of [criteria](http://learn.akamai.com/en-us/api/core_features/property_manager/vlatest.html#criteria) you may apply within a property version's rules. The available set is determined by the product under which you created the property, and any additional modules enabled under your account.\n\nNote that this list of available criteria is more accurate than that specified in the [rule format schema](https://papi-akamai.readme.io/reference/schemasproductsproductidruleformat#get_schemas-products-productid-ruleformat), which includes criteria you may potentially add to your contract for a given product, but that aren't currently active. However, it only lists criteria _currently_ available on your contract, so you should only use it to list available criteria for the current property version. If you had a behavior enabled at one time, but then dropped it from your contract, a list of available criteria for an older property version might be inaccurate.\n",
"operationId": "Listavailablecriteria",
"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": "propertyVersion",
"in": "path",
"description": "(Required) Property's incremental version number.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{propertyVersion}}"
}
},
{
"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}/versions": {
"get": {
"tags": [
"versions"
],
"summary": "List property versions",
"description": "Lists the property's versions, with results limited to the 500 most recent versions. Optionally paginate the results. Each property version indicates activation status on different networks, and an `etag` digest useful when [cloning the property](https://papi-akamai.readme.io/reference/properties#post_properties).\n",
"operationId": "Listpropertyversions",
"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": "offset",
"in": "query",
"description": "For paginated responses, specifies the page of results to\ninclude, starting from `0`.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 96138151
}
},
{
"name": "limit",
"in": "query",
"description": "For paginated responses, specifies the number of results to\ninclude on each page.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 6823929
}
},
{
"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": [
"versions"
],
"summary": "Create a new property version",
"description": "Create a new property version\nbased on any previous version. All data from the\n`createFromVersion` populates the new version, including its\nrules and hostnames. Specify `createFromVersionEtag` if you\nwant to ensure you're creating from a version that hasn't\nchanged since you fetched it.\n",
"operationId": "Createanewpropertyversion",
"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/CreateanewpropertyversionRequest"
},
"example": {
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/properties/{propertyId}/versions/latest": {
"get": {
"tags": [
"versions"
],
"summary": "Get the latest version",
"description": "This operation provides either the latest property version overall, or the latest one active on the production or staging networks. By default, the response yields the property version with the highest number. Specifying an `activatedOn` of `STAGING` or `PRODUCTION` yields the version that's currently active on either network.\n",
"operationId": "Getthelatestversion",
"parameters": [
{
"name": "activatedOn",
"in": "query",
"description": "If present, returns the latest version activated on the\ngiven network, either `STAGING` or `PRODUCTION`.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "STAGING"
}
},
{
"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
}
},
"/properties/{propertyId}": {
"delete": {
"tags": [
"{property Id}"
],
"summary": "Remove a property",
"description": "Removes a specific property, which you can only do if none of\nits versions are currently active. Activating another\nproperty with the same set of hostnames automatically triggers\na deactivation on the targeted property. See\n[Create a new activation](https://papi-akamai.readme.io/reference/propertiespropertyidactivations#post_properties-propertyid-activations) for details.\nA successful DELETE results in a 200 response with the link to\nthe remaining properties for the given contract and group.\nAttempting to delete an active property results in a 500\nerror. Attempting to delete an unknown property results in a\n404 error.\n",
"operationId": "Removeaproperty",
"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}}"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
},
"get": {
"tags": [
"{property Id}"
],
"summary": "Get a property",
"description": "This operation gets a specific property. You can call this operation by specifying any of the `propertyId` members from a [list of properties](https://papi-akamai.readme.io/reference/properties#get_properties), or by running a GET on the `propertyLink` response when [creating a new property](https://papi-akamai.readme.io/reference/properties#post_properties).\n",
"operationId": "Getaproperty",
"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": "{{proipertyId}}"
}
},
{
"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": {
"get": {
"tags": [
"properties"
],
"summary": "List properties",
"description": "This operation lists properties available for the current contract and group.\n",
"operationId": "Listproperties",
"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": [
"properties"
],
"summary": "Create or clone a property",
"description": "This operation either creates a new property from scratch, or\nbases one on another property's rule tree and optionally its set\nof assigned hostnames.\n\nWhen cloning with `copyHostnames` enabled, you can apply the\nsame set of hostnames as the original property. Regardless,\nthe new property clones the rule tree from the original,\nalong with its assigned `ruleFormat`. Setting\n`cloneFromVersionEtag` allows you to perform an etags check\nto ensure the original property hasn't changed. See\n[Concurrency control](doc:concurrency-control) for guidance.\n\nNote that unlike a new property version, a property that you\nclone along with all of its hostnames can be activated\nindependently of the property on which it was based. If you\nactivate a property that specifies hostnames that are\nalready active on another property, the other property\nautomatically gets a new version activated without the\ncommon set of hostnames, or deactivated if all its hostnames\nare part of the new property.\n\nPAPI's ability to create and clone new properties means that\nyou can design a system of rule templates targeted to\nspecific domains, rather than maintain a single set of rules\nwith conditional logic for your full range of\ndomains. Maintaining properties manually within the Control\nCenter interface limited you to that more consolidated\napproach, but PAPI allows you to deploy rules more\nefficiently. In either case, PAPI makes it much easier for\nyou to support a large, flexible set of domains.\n",
"operationId": "Createorcloneaproperty",
"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/CreateorcloneapropertyRequest"
},
"example": {
"cloneFrom": {
"cloneFromVersionEtag": "a9dfe78cf93090516bde891d009eaf57",
"copyHostnames": true,
"propertyId": "prp_175780",
"version": 2
},
"productId": "prd_Alta",
"propertyName": "my.new.property.com"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/schemas/products/{productId}/{ruleFormat}": {
"get": {
"tags": [
"schemas"
],
"summary": "Get a rule format's schema",
"description": "Get the JSON schema for the given product and rule format, which you can use to validate a rule tree object. Note that your rule tree may still fail to activate if you specify features that are optional within the schema for a product but not currently supported on your contract. To validate the set of currently available features you want to activate, run [List available behaviors](https://papi-akamai.readme.io/reference-link/get_properties-propertyid-versions-propertyversion-available-behaviors) and [List available criteria](https://papi-akamai.readme.io/reference/propertiespropertyidversionspropertyversionavailable-criteria#get_properties-propertyid-versions-propertyversion-available-criteria).\n",
"operationId": "Getaruleformat'sschema",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "(Required) Unique identifier for the product.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `prd_` prefix.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{productId}}"
}
},
{
"name": "ruleFormat",
"in": "path",
"description": "(Required) Name of the rule format, either one frozen to a specific\ndate, or representing the `latest` set of behaviors and\ncriteria.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{ruleFormat}}"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/schemas/request/{filename}": {
"get": {
"tags": [
"schemas"
],
"summary": "Get a request's schema",
"description": "Fetch the JSON schema for a particular request. These are typically linked from error messages about schema mismatches.\n",
"operationId": "Getarequest'sschema",
"parameters": [
{
"name": "filename",
"in": "path",
"description": "(Required) Schema's filename.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{filename}}"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/build": {
"get": {
"tags": [
"papi/v1"
],
"summary": "Get build details",
"description": "Gets information about the current API release. Note that available information about version numbers and build dates are unrelated to the overall API version or to various rule format versions. See [API versioning](doc:api-versioning) for details.\n",
"operationId": "Getbuilddetails",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/contracts": {
"get": {
"tags": [
"papi/v1"
],
"summary": "List contracts",
"description": "You need information about the prevailing contract to access most PAPI interfaces. This operation provides a read-only list of contract names and identifiers. The response provides context on the overall account that enables each contract and keys your API credentials, but you don't need it to access any PAPI objects.\n",
"operationId": "Listcontracts",
"parameters": [
{
"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
}
},
"/debug/client-info": {
"get": {
"tags": [
"papi/v1"
],
"summary": "GET debug-client-info",
"operationId": "GETdebug-client-info",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/groups": {
"get": {
"tags": [
"papi/v1"
],
"summary": "List groups",
"description": "You need information about the prevailing group to access most PAPI interfaces. This operation provides a read-only list of groups, which may contain properties. This operation provides a flat list of groups, along with `parentGroupId` information to structure them as a hierarchy. Each group also lists any available contracts that enable property features, but not which group contains a given property. The [Identity Management: User Administration API](http://learn.akamai.com/en-us/api/core_features/identity_management_user_admin/v2.html) allows you to associate properties with groups, and to modify the group hierarchy. SIERRA TEST: See [ID prefixes](doc:id-prefixes). Links to guide doc work!\n",
"operationId": "Listgroups",
"parameters": [
{
"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
}
},
"/rule-formats": {
"get": {
"tags": [
"papi/v1"
],
"summary": "List rule formats",
"description": "Gets a list of available rule formats. These dated version strings available in the response's `ruleFormats.items` array allow you to control the set of behaviors and criteria you invoke within a property's rules to apply to edge content, either [freezing](doc:freeze-a-rule-trees-feature-set) a rule tree or [updating](doc:update-rules-to-a-newer-set-of-features) to a new rule format. To validate a rule tree to the requirements of a specific rule format, see [Get a rule format's schema](https://papi-akamai.readme.io/reference/schemasproductsproductidruleformat#get_schemas-products-productid-ruleformat).\n",
"operationId": "Listruleformats",
"parameters": [
{
"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
}
},
"/search/find-by-value": {
"post": {
"tags": [
"papi/v1"
],
"summary": "Search properties",
"description": "This operation searches properties by name, or by the\nhostname or edge hostname for which it's currently\nactive. Specify a [Search](#search) request object with a\nsingle query member. The response lists the matching set of\ncurrently active property versions, and also the latest\nversion if inactive. Each of the response's\n[Version](#version) objects features additional context for\nthe property in which it appears, or the account, contract,\nor group under which the property was provisioned. Note that\nto perform more complex searches for content within a rule\ntree, run [Bulk search a set of\nproperties](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) instead. Does <>\nwork? No.\n",
"operationId": "Searchproperties",
"parameters": [
{
"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/SearchpropertiesRequest"
},
"example": {
"propertyName": "www.example.com_pm"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/validate/rules": {
"post": {
"tags": [
"papi/v1"
],
"summary": "Validate rules without persistence",
"description": "Operation is Akamai-internal.\n",
"operationId": "Validateruleswithoutpersistence",
"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/ValidateruleswithoutpersistenceRequest"
},
"example": {
"productId": "eu fugiat officia magna consectetur",
"propertyName": "cupidatat ve",
"cloneFrom": {
"propertyId": "aliqua magna",
"version": 53238157,
"copyHostnames": false
},
"ruleFormat": "qui reprehenderit sint",
"rules": {}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
}
},
"components": {
"schemas": {
"BulkactivateasetofpropertiesRequest": {
"title": "BulkactivateasetofpropertiesRequest",
"required": [
"activatePropertyVersions",
"defaultActivationSettings"
],
"type": "object",
"properties": {
"activatePropertyVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivatePropertyVersion"
},
"description": ""
},
"defaultActivationSettings": {
"$ref": "#/components/schemas/DefaultActivationSettings"
}
},
"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
}
}
},
"ActivatePropertyVersion": {
"title": "ActivatePropertyVersion",
"required": [
"network",
"note",
"propertyId",
"propertyVersion"
],
"type": "object",
"properties": {
"network": {
"type": "string"
},
"note": {
"type": "string"
},
"propertyId": {
"type": "string"
},
"propertyVersion": {
"type": "integer",
"format": "int32"
},
"notifyEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"acknowledgeAllWarnings": {
"type": "boolean"
},
"acknowledgeWarnings": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"example": {
"network": "STAGING",
"note": "Some activation note",
"propertyId": "prp_1",
"propertyVersion": 2
}
},
"DefaultActivationSettings": {
"title": "DefaultActivationSettings",
"required": [
"acknowledgeAllWarnings",
"fastPush",
"notifyEmails",
"useFastFallback"
],
"type": "object",
"properties": {
"acknowledgeAllWarnings": {
"type": "boolean"
},
"fastPush": {
"type": "boolean"
},
"notifyEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"useFastFallback": {
"type": "boolean"
}
},
"example": {
"acknowledgeAllWarnings": true,
"fastPush": true,
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"useFastFallback": false
}
},
"BulkversionasetofpropertiesRequest": {
"title": "BulkversionasetofpropertiesRequest",
"required": [
"createPropertyVersions"
],
"type": "object",
"properties": {
"createPropertyVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreatePropertyVersion"
},
"description": ""
}
},
"example": {
"createPropertyVersions": [
{
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b",
"propertyId": "prp_1"
},
{
"createFromVersion": 2,
"createFromVersionEtag": "343410c585cf67fc",
"propertyId": "prp_15"
},
{
"createFromVersion": 10,
"createFromVersionEtag": "6c7v5c65c6cvcv65",
"propertyId": "prp_3"
}
]
}
},
"CreatePropertyVersion": {
"title": "CreatePropertyVersion",
"required": [
"createFromVersion",
"createFromVersionEtag",
"propertyId"
],
"type": "object",
"properties": {
"createFromVersion": {
"type": "integer",
"format": "int32"
},
"createFromVersionEtag": {
"type": "string"
},
"propertyId": {
"type": "string"
}
},
"example": {
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b",
"propertyId": "prp_1"
}
},
"BulkpatchasetofpropertiesRequest": {
"title": "BulkpatchasetofpropertiesRequest",
"required": [
"patchPropertyVersions"
],
"type": "object",
"properties": {
"patchPropertyVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PatchPropertyVersion"
},
"description": ""
}
},
"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
}
]
}
},
"PatchPropertyVersion": {
"title": "PatchPropertyVersion",
"required": [
"etag",
"patches",
"propertyId",
"propertyVersion"
],
"type": "object",
"properties": {
"etag": {
"type": "string"
},
"patches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Patch"
},
"description": ""
},
"propertyId": {
"type": "string"
},
"propertyVersion": {
"type": "integer",
"format": "int32"
}
},
"example": {
"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
}
},
"Patch": {
"title": "Patch",
"required": [
"op",
"path",
"value"
],
"type": "object",
"properties": {
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"value": {
"type": "string"
}
},
"example": {
"op": "replace",
"path": "/rules/children/1/features/3/option/enabled",
"value": "on"
}
},
"BulksearchasetofpropertiesRequest": {
"title": "BulksearchasetofpropertiesRequest",
"required": [
"bulkSearchQuery"
],
"type": "object",
"properties": {
"bulkSearchQuery": {
"$ref": "#/components/schemas/BulkSearchQuery"
}
},
"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"
}
}
},
"BulkSearchQuery": {
"title": "BulkSearchQuery",
"required": [
"bulkSearchQualifiers",
"match",
"syntax"
],
"type": "object",
"properties": {
"bulkSearchQualifiers": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"match": {
"type": "string"
},
"syntax": {
"type": "string"
}
},
"example": {
"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"
}
},
"SynchronouslybulksearchasetofpropertiesRequest": {
"title": "SynchronouslybulksearchasetofpropertiesRequest",
"required": [
"bulkSearchQuery"
],
"type": "object",
"properties": {
"bulkSearchQuery": {
"$ref": "#/components/schemas/BulkSearchQuery"
}
},
"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"
}
}
},
"UpdateclientsettingsRequest": {
"title": "UpdateclientsettingsRequest",
"required": [
"ruleFormat",
"usePrefixes"
],
"type": "object",
"properties": {
"ruleFormat": {
"type": "string"
},
"usePrefixes": {
"type": "boolean"
}
},
"example": {
"ruleFormat": "v2015-08-08",
"usePrefixes": true
}
},
"CreateanewCPcodeRequest": {
"title": "CreateanewCPcodeRequest",
"required": [
"cpcodeName",
"productId"
],
"type": "object",
"properties": {
"cpcodeName": {
"type": "string"
},
"productId": {
"type": "string"
}
},
"example": {
"cpcodeName": "SME WAA",
"productId": "prd_Web_App_Accel"
}
},
"CreateanewcustombehaviorRequest": {
"title": "CreateanewcustombehaviorRequest",
"required": [
"approvedByUser",
"description",
"displayName",
"name",
"sharingLevel",
"xml"
],
"type": "object",
"properties": {
"approvedByUser": {
"type": "string"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"sharingLevel": {
"type": "string"
},
"xml": {
"type": "string"
}
},
"example": {
"approvedByUser": "jlandis",
"description": "MDC Behavior\n",
"displayName": "Multiple Domain Configuration",
"name": "mdc",
"sharingLevel": "ACCOUNT",
"xml": "This is where the Metadata goes"
}
},
"CreateanewcustomoverrideRequest": {
"title": "CreateanewcustomoverrideRequest",
"required": [
"approvedByUser",
"description",
"displayName",
"name",
"sharingLevel",
"xml"
],
"type": "object",
"properties": {
"approvedByUser": {
"type": "string"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"sharingLevel": {
"type": "string"
},
"xml": {
"type": "string"
}
},
"example": {
"approvedByUser": "jlandis",
"description": "MDC Behavior\n",
"displayName": "Multiple Domain Configuration",
"name": "mdc",
"sharingLevel": "ACCOUNT",
"xml": "This is where the Metadata goes"
}
},
"CreateanewedgehostnameRequest": {
"title": "CreateanewedgehostnameRequest",
"required": [
"domainPrefix",
"domainSuffix",
"ipVersionBehavior",
"productId",
"secureNetwork",
"useCases"
],
"type": "object",
"properties": {
"domainPrefix": {
"type": "string"
},
"domainSuffix": {
"type": "string"
},
"ipVersionBehavior": {
"type": "string"
},
"productId": {
"type": "string"
},
"secureNetwork": {
"type": "string"
},
"useCases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UseCase"
},
"description": ""
}
},
"example": {
"domainPrefix": "www.example.com",
"domainSuffix": "edgesuite.net",
"ipVersionBehavior": "IPV4",
"productId": "prd_Dynamic_Site_Del",
"secureNetwork": "STANDARD_TLS",
"useCases": [
{
"option": "BACKGROUND",
"type": "GLOBAL",
"useCase": "Download_Mode"
}
]
}
},
"UseCase": {
"title": "UseCase",
"required": [
"option",
"type",
"useCase"
],
"type": "object",
"properties": {
"option": {
"type": "string"
},
"type": {
"type": "string"
},
"useCase": {
"type": "string"
}
},
"example": {
"option": "BACKGROUND",
"type": "GLOBAL",
"useCase": "Download_Mode"
}
},
"CreateanewactivationordeactivationRequest": {
"title": "CreateanewactivationordeactivationRequest",
"required": [
"acknowledgeWarnings",
"network",
"note",
"notifyEmails",
"propertyVersion",
"useFastFallback"
],
"type": "object",
"properties": {
"acknowledgeWarnings": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"network": {
"type": "string"
},
"note": {
"type": "string"
},
"notifyEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"propertyVersion": {
"type": "integer",
"format": "int32"
},
"useFastFallback": {
"type": "boolean"
}
},
"example": {
"acknowledgeWarnings": [
"msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f"
],
"network": "STAGING",
"note": "Sample activation",
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"propertyVersion": 1,
"useFastFallback": false
}
},
"UpdateapropertyshostnamesRequest": {
"title": "UpdateapropertyshostnamesRequest",
"required": [
"cnameFrom",
"cnameType"
],
"type": "object",
"properties": {
"cnameFrom": {
"type": "string"
},
"cnameTo": {
"type": "string"
},
"cnameType": {
"type": "string"
},
"edgeHostnameId": {
"type": "string"
}
},
"example": {
"cnameFrom": "m.example.com",
"cnameTo": "example.com.edgesuite.net",
"cnameType": "EDGE_HOSTNAME"
}
},
"PatcharuletreeRequest": {
"title": "PatcharuletreeRequest",
"required": [
"op",
"path",
"value"
],
"type": "object",
"properties": {
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
},
"example": {
"op": "replace",
"path": "/rules/options/is_secure",
"value": true
}
},
"UpdatearuletreeRequest": {
"title": "UpdatearuletreeRequest",
"required": [
"rules"
],
"type": "object",
"properties": {
"rules": {
"$ref": "#/components/schemas/Rules"
}
},
"example": {
"rules": {
"children": [
{
"behaviors": [
{
"behavior": "max-age",
"name": "caching",
"ttl": "1m"
}
],
"criteria": [
{
"name": "path",
"value": [
"/my-path"
]
}
],
"criteriaMustSatisfy": "all",
"name": "Handle /my-path"
}
],
"name": "default"
}
}
},
"Rules": {
"title": "Rules",
"required": [
"children",
"name"
],
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Child"
},
"description": ""
},
"name": {
"type": "string"
}
},
"example": {
"children": [
{
"behaviors": [
{
"behavior": "max-age",
"name": "caching",
"ttl": "1m"
}
],
"criteria": [
{
"name": "path",
"value": [
"/my-path"
]
}
],
"criteriaMustSatisfy": "all",
"name": "Handle /my-path"
}
],
"name": "default"
}
},
"Child": {
"title": "Child",
"required": [
"behaviors",
"criteria",
"criteriaMustSatisfy",
"name"
],
"type": "object",
"properties": {
"behaviors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Behavior"
},
"description": ""
},
"criteria": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Criterion"
},
"description": ""
},
"criteriaMustSatisfy": {
"type": "string"
},
"name": {
"type": "string"
}
},
"example": {
"behaviors": [
{
"behavior": "max-age",
"name": "caching",
"ttl": "1m"
}
],
"criteria": [
{
"name": "path",
"value": [
"/my-path"
]
}
],
"criteriaMustSatisfy": "all",
"name": "Handle /my-path"
}
},
"Behavior": {
"title": "Behavior",
"required": [
"behavior",
"name",
"ttl"
],
"type": "object",
"properties": {
"behavior": {
"type": "string"
},
"name": {
"type": "string"
},
"ttl": {
"type": "string"
}
},
"example": {
"behavior": "max-age",
"name": "caching",
"ttl": "1m"
}
},
"Criterion": {
"title": "Criterion",
"required": [
"name",
"value"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"example": {
"name": "path",
"value": [
"/my-path"
]
}
},
"CreateanewpropertyversionRequest": {
"title": "CreateanewpropertyversionRequest",
"required": [
"createFromVersion",
"createFromVersionEtag"
],
"type": "object",
"properties": {
"createFromVersion": {
"type": "integer",
"format": "int32"
},
"createFromVersionEtag": {
"type": "string"
}
},
"example": {
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b"
}
},
"CreateorcloneapropertyRequest": {
"title": "CreateorcloneapropertyRequest",
"required": [
"cloneFrom",
"productId",
"propertyName"
],
"type": "object",
"properties": {
"cloneFrom": {
"$ref": "#/components/schemas/CloneFrom"
},
"productId": {
"type": "string"
},
"propertyName": {
"type": "string"
}
},
"example": {
"cloneFrom": {
"cloneFromVersionEtag": "a9dfe78cf93090516bde891d009eaf57",
"copyHostnames": true,
"propertyId": "prp_175780",
"version": 2
},
"productId": "prd_Alta",
"propertyName": "my.new.property.com"
}
},
"CloneFrom": {
"title": "CloneFrom",
"required": [
"cloneFromVersionEtag",
"copyHostnames",
"propertyId",
"version"
],
"type": "object",
"properties": {
"cloneFromVersionEtag": {
"type": "string"
},
"copyHostnames": {
"type": "boolean"
},
"propertyId": {
"type": "string"
},
"version": {
"type": "integer",
"format": "int32"
}
},
"example": {
"cloneFromVersionEtag": "a9dfe78cf93090516bde891d009eaf57",
"copyHostnames": true,
"propertyId": "prp_175780",
"version": 2
}
},
"SearchpropertiesRequest": {
"title": "SearchpropertiesRequest",
"required": [
"propertyName"
],
"type": "object",
"properties": {
"propertyName": {
"type": "string"
}
},
"example": {
"propertyName": "www.example.com_pm"
}
},
"ValidateruleswithoutpersistenceRequest": {
"title": "ValidateruleswithoutpersistenceRequest",
"required": [
"productId",
"propertyName",
"cloneFrom",
"ruleFormat",
"rules"
],
"type": "object",
"properties": {
"productId": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"cloneFrom": {
"$ref": "#/components/schemas/CloneFrom1"
},
"ruleFormat": {
"type": "string"
},
"rules": {
"type": "object"
}
},
"example": {
"productId": "eu fugiat officia magna consectetur",
"propertyName": "cupidatat ve",
"cloneFrom": {
"propertyId": "aliqua magna",
"version": 53238157,
"copyHostnames": false
},
"ruleFormat": "qui reprehenderit sint",
"rules": {}
}
},
"CloneFrom1": {
"title": "CloneFrom1",
"required": [
"propertyId",
"version",
"copyHostnames"
],
"type": "object",
"properties": {
"propertyId": {
"type": "string"
},
"version": {
"type": "integer",
"format": "int32"
},
"copyHostnames": {
"type": "boolean"
}
},
"example": {
"propertyId": "aliqua magna",
"version": 53238157,
"copyHostnames": false
}
}
}
},
"tags": [
{
"name": "activations"
},
{
"name": "property-version-creations"
},
{
"name": "rules-patch-requests"
},
{
"name": "rules-search-requests"
},
{
"name": "bulk"
},
{
"name": "client-settings"
},
{
"name": "cpcodes"
},
{
"name": "{behavior Id}"
},
{
"name": "custom-behaviors"
},
{
"name": "{override Id}"
},
{
"name": "custom-overrides"
},
{
"name": "edgehostnames"
},
{
"name": "products"
},
{
"name": "{activation Id}"
},
{
"name": "hostnames"
},
{
"name": "rules"
},
{
"name": "{property Version}"
},
{
"name": "versions"
},
{
"name": "{property Id}"
},
{
"name": "properties"
},
{
"name": "schemas"
},
{
"name": "papi/v1"
}
]
}