Property Manager API Data

This section describes Property Manager API’s various data structures.

Most of the API’s GET data is structured within outer envelope objects, which provide additional contextual metadata about the requested object. Relevant data for most resources is available within a nested items array, even if the request yields a single record. When writing to the API, you often POST these smaller objects rather than perform a PUT on the entire data structure. For example, a GET may yield this hypothetical data structure:

{
    "contextualMember": true,
    "nouns": {
        "items": [
            { "nounName": "resource" }
        ]
    }
}

To write new data, you would POST only the inner object to the same endpoint:

{ "nounName": "endpoint" }

The following members may appear within the outer envelope object:

Member Type Description
accountId String A unique identifier for the prevailing account. See Data Conventions for details on how to omit the ID’s act_ prefix.
accountName String A descriptive name for the account.
assetId String An alternative property identifier, for internal use.
contractId String A unique identifier for the prevailing contract. See Data Conventions for details on how to omit the ID’s ctr_ prefix.
groupId String A unique identifier for the prevailing group. See Data Conventions for details on how to omit the ID’s grp_ prefix.
etag String A digest with which to check the data’s integrity.
propertyId String A unique identifier for the property. See Data Conventions for details on how to omit the ID’s prp_ prefix.
propertyVersion Number Identifies a property instance.
propertyName String A descriptive name for the property.
ruleFormat String A read-only value that indicates the versioned set of features and criteria that are currently applied to a rule tree.

The data schema tables below list membership requirements as follows:

Member is required to be present, regardless of whether the value is empty or null.
Member is optional, and may be omitted in some cases.

Schemas

Group

Encapsulates information about the group that contains a property and allows it to be deployed. Relevant response objects appear within the outer envelope’s groups.items array.

Sample GET response:

{
  "accountId": "act_1-1TJZFB",
  "accountName": "Example.com",
  "groups": {
    "items": [
      {
        "groupName": "Example.com-1-1TJZH5",
        "groupId": "grp_15225",
        "contractIds": [
          "ctr_1-1TJZH5"
        ]
      },
      {
        "groupName": "Test",
        "groupId": "grp_15231",
        "parentGroupId": "grp_15225",
        "contractIds": [
          "ctr_1-1TJZH5"
        ]
      },
      {
        "groupName": "TomTest",
        "groupId": "grp_41443",
        "parentGroupId": "grp_15225",
        "contractIds": [
          "ctr_1-1TJZH5"
        ]
      }
    ]
  }
}

Group Members

Member Type Required Description
contractIds Array A set of string identifiers for contracts whose products can be applied to properties within a group.
groupId String A unique identifier for the group. See Data Conventions for details on how to omit the ID’s grp_ prefix.
groupName String A descriptive label for the group.
parentGroupId String Identifies another group as a parent, defining the relative location of the group within the group hierarchy. If omitted, it is the root-level group at the top of the hierarchy.

Contract

Encapsulates information about the contract under which a property may be deployed. Relevant response objects appear within the outer envelope’s contracts.items array.

Sample GET response:

{
  "accountId": "act_1-1TJZFB",
  "contracts": {
    "items": [
      {
        "contractId": "ctr_1-1TJZH5",
        "contractTypeName": "Direct Customer"
      }
    ]
  }
}

Contract Members

Member Type Required Description
contractId String A unique identifier for the contract. See Data Conventions for details on how to omit the ID’s ctr_ prefix.
contractTypeName Enumeration Distinguishes the type of contract, either Direct Customer or Indirect Customer.

Product

Encapsulates information on the product that determines a property’s available range of features. Relevant response objects appear within the outer envelope’s products.items array.

Sample GET response:

{
  "accountId": "act_1-1TJZFB",
  "contractId": "ctr_1-1TJZH5",
  "products": {
    "items": [
      {
        "productName": "Alta",
        "productId": "prd_Alta"
      }
    ]
  }
}

Product Members

Member Type Required Description
productId String A unique identifier for the product. See Data Conventions for details on how to omit the ID’s prd_ prefix.
productName String A descriptive name for the product.

CpCode

Specifies billing and reporting codes. To make a POST request that creates a new CP code, specify an object with productId and cpcodeName members. Relevant response objects appear within the outer envelope’s cpcodes.items array.

Sample GET response:

{
  "accountId": "act_1-1TJZFB",
  "contractId": "ctr_1-1TJZFW",
  "groupId": "grp_15166",
  "cpcodes": {
    "items": [
      {
        "cpcodeId": "cpc_33190",
        "cpcodeName": "SME WAA",
        "productIds": [
          "prd_Web_App_Accel"
        ],
        "createdDate": "2015-03-02T15:06:13Z"
      }
    ]
  }
}

Sample POST request:

{
  "productId": "prd_Web_App_Accel",
  "cpcodeName": "SME WAA"
}

CpCode Members

Member Type Required Description
cpcodeId String A unique identifier for the CP code. See Data Conventions for details on how to omit the ID’s cpc_ prefix.
cpcodeName String A descriptive label for the CP code.
createdDate String Read-only. A time stamp for the CP code.
productId String On POST, the product to assign to this CP code. See Data Conventions for details on how to omit the ID’s prd_ prefix.
productIds Array On GET, lists identifiers for products assigned to this CP code. (Note that PAPI does not support Property Manager’s ability to assign more than one product to a CP code.)

EdgeHostname

Specifies a set of available hostnames to which a property version may be applied. To POST a new edge hostname, specify a single object with productId, domainPrefix, and domainSuffix members, and optional ipVersionBehavior and secure members. Relevant response objects appear within the outer envelope’s edgehostnames.items array.

Sample POST request:

{
  "productId": "prd_PPP",
  "domainPrefix": "www.example.com",
  "domainSuffix": "edgesuite.net",
  "secure": true,
  "ipVersionBehavior": "IPV4",
  "slotNumber": 12345
}

Sample GET response:

{
  "accountId": "act_1-1TJZFB",
  "contractId": "ctr_1-1TJZH5",
  "groupId": "grp_15225",
  "edgeHostnames": {
    "items": [
      {
        "edgeHostnameId": "ehn_887436",
        "edgeHostnameDomain": "example.com.edgesuite.net",
        "productId": "prd_Alta",
        "domainPrefix": "example.com",
        "domainSuffix": "edgesuite.net",
        "secure": false,
        "ipVersionBehavior": "IPV4",
        "mapDetails:serialNumber": 1951,
        "mapDetails:mapDomain": "a1951.g.akamai.net"
      }
    ]
  }
}

EdgeHostname Members

Member Type Required Description
domainPrefix String The origin domain portion of the edge hostname. An edge hostname consists of a customer-specific namePrefix such as www.example.com and an Akamai-specific domainSuffix such as edgesuite.net. The edge hostname’s final DNS CNAME combines the two, for example, www.example.com.edgesuite.net.
domainSuffix String The Akamai-specific portion of the edge hostname, for example, edgesuite.net.
edgeHostnameDomain String The full edge domain name formed from the domainPrefix and domainSuffix.
edgeHostnameId String The edge hostname’s unique identifier, which can be assigned to a property. See Data Conventions for details on how to omit the ID’s ehn_ prefix.
ipVersionBehavior Enumeration Which version of the IP protocol to use: IPV4 for version 4 only, or IPV6_COMPLIANCE for both 4 and 6. The default value for requests is IPV4.
productId String The product associated with the edge hostname. See Data Conventions for details on how to omit the ID’s prd_ prefix.
secure Boolean Set to true if the edge hostname is to be used with SSL. The default value for POST requests is false. (Setting secure:true for new edge hostnames is not supported.)
slotNumber Integer On POST, sets the slot number for ESSL (secure) properties.
status Enumeration Appears as PENDING for any newly defined hostname whose DNS mapping has not yet been distributed across the entire Akamai network. If status is omitted, it indicates the edge hostname is active. (Do not confuse an edge hostname’s status with a property activation’s deployment status.)

Property

Contains configuration data to apply to edge content. Relevant response objects appear within the outer envelope’s properties.items array.

Sample POST request, cloning another property:

{
  "productId": "prd_Alta",
  "propertyName": "my.new.property.com",
  "cloneFrom": {
    "propertyId": "prp_175780",
    "version": 2,
    "cloneFromVersionEtag": "a9dfe78cf93090516bde891d009eaf57",
    "copyHostnames": true
  }
}

Sample GET response:

{
  "properties": {
    "items": [
      {
        "accountId": "act_1-1TJZFB",
        "contractId": "ctr_1-1TJZH5",
        "groupId": "grp_15225",
        "propertyId": "prp_175780",
        "propertyName": "example.com",
        "latestVersion": 2,
        "stagingVersion": 1,
        "productionVersion": null,
        "assetId": "aid_101",
        "note": "Notes about example.com"
      }
    ]
  }
}

Property Members

Member Type Required Description
accountId String Read-only. Identifies the account under which the property was created. See Data Conventions for details on how to omit the ID’s act_ prefix.
assetId String An alternative identifier for the property, for internal use.
cloneFrom Property.cloneFrom Optionally identifies another property instance to clone when making a POST request to create a new property. The cloned property must share the same contract and group.
contractId String Identifies the contract under which the property was created. See Data Conventions for details on how to omit the ID’s ctr_ prefix.
groupId String Identifies the group to which the property is assigned. See Data Conventions for details on how to omit the ID’s grp_ prefix.
latestVersion Integer Specifies the most recent version of the property.
note String Further descriptive commentary.
productId String The product assigned to the property, required when POSTing a new property. See Data Conventions for details on how to omit the ID’s prd_ prefix.
productionVersion Integer, Null The most recent version to be activated to the production network, otherwise null.
propertyId String The property’s unique identifier. See Data Conventions for details on how to omit the ID’s prp_ prefix.
propertyName String A descriptive name for the property.
ruleFormat String On GET, reflects the property’s current format. Otherwise on POST, assigns a specific rule format to the property. Ignored on PUT, since you need to modify the Content-Type to change rule formats. For details, see Update Rules to a Newer Set of Features.
stagingVersion Integer, Null The most recent version to be activated to the test network, otherwise null.

Property.cloneFrom  

Optionally identifies another property instance to clone when making a POST request to create a new property. The cloned property must share the same contract and group.

Member Type Required Description
cloneFromVersionEtag String Performs an etag data integrity check on the original property. See Concurrency Control for guidance.
copyHostnames Boolean Assigns the same set of hostnames to the new property, false by default.
propertyId String Specifies the property to clone. See Data Conventions for details on how to omit the ID’s prp_ prefix.
version Integer Specifies the version of the property to clone.

Version

Specifies the version of a property. Relevant response objects appear within the outer envelope’s versions.items array. Additional contextual members appear in response to searching properties.

Sample GET response:

{
  "propertyId": "prp_173136",
  "propertyName": "981.catalog.amenai.net",
  "accountId": "act_1-1TJZFB",
  "contractId": "ctr_1-1TJZH5",
  "groupId": "grp_15225",
  "assetId": "aid_101",
  "versions": {
    "items": [
      {
        "propertyVersion": 1,
        "updatedByUser": "afaden",
        "updatedDate": "2014-03-04T21:12:57Z",
        "productionStatus": "ACTIVE",
        "stagingStatus": "INACTIVE",
        "etag": "71573b922a87abc3",
        "productId": "prd_Alta",
        "ruleFormat": "latest",
        "note": "initial version"
      }
    ]
  }
}

Version Members

Member Type Required Description
accountId String Read-only. In search results, identifies the account under which the property version is active. See Data Conventions for details on how to omit the ID’s act_ prefix.
assetId String In search results, provides an alternative property identifier, for internal use.
contractId String Read-only. In search results, identifies the contract under which the property version is active. See Data Conventions for details on how to omit the ID’s ctr_ prefix.
edgeHostname String Read-only. When searching for hostname or edgeHostname, this shows the edge hostname to which the active version currently applies.
etag String A digest with which to check the data’s integrity. See Concurrency Control for guidance.
groupId String Read-only. In search results, identifies the group under which the property version is active. See Data Conventions for details on how to omit the ID’s grp_ prefix.
hostname String Read-only. When searching for hostname or edgeHostname, this shows the property hostname to which the active version currently applies.
note String A descriptive log comment.
productId String The product assigned to the property when versioned. See Data Conventions for details on how to omit the ID’s prd_ prefix.
productionStatus Enumeration Whether the version has been activated to the production network. (If ACTIVE, the version is read-only. Otherwise it may be INACTIVE or PENDING.)
propertyId String Read-only. In search results, identifies the property to which the listed version belongs. See Data Conventions for details on how to omit the ID’s prp_ prefix.
propertyName String Read-only. In search results, provides the name of the property to which the listed version belongs.
propertyVersion Integer Read-only. A positive integer identifying the incremental version.
ruleFormat String Identifies the rule format currently assigned to the property version’s rule tree.
stagingStatus Enumeration Whether the version has been activated to the test network. (If ACTIVE, the version is read-only. Otherwise it may be INACTIVE or PENDING.)
updatedByUser String Read-only. The username associated with the new version.
updatedDate String Read-only. The date stamp of the version’s latest update.

VersionPost

When incrementing a new version, you POST an object whose members are not reflected in subsequent Version responses.

Sample POST request:

{
  "createFromVersion": 1,
  "createFromVersionEtag": "2641910c585cf67b"
}

VersionPost Members

Member Type Required Description
createFromVersion Integer The property version on which to base the new version.
createFromVersionEtag String The data digest of the version on which to base the new version. See Concurrency Control for guidance.

Hostname

Specifies an edge hostname that is applied to a property version. Writing data to this resource requires that you PUT an array of all the hostname objects, each containing edgeHostnameId, cnameFrom, and cnameTo members. This request array matches the hostnames.items in the response.

Sample GET response:

{
  "accountId": "act_1-1TJZFB",
  "contractId": "ctr_1-1TJZH5",
  "groupId": "grp_15225",
  "propertyId": "prp_175780",
  "propertyVersion": 1,
  "etag": "6aed418629b4e5c0",
  "hostnames": {
    "items": [
      {
        "cnameType": "EDGE_HOSTNAME",
        "edgeHostnameId": "ehn_895822",
        "cnameFrom": "example.com",
        "cnameTo": "example.com.edgesuite.net"
      },
      {
        "cnameType": "EDGE_HOSTNAME",
        "edgeHostnameId": "ehn_895833",
        "cnameFrom": "m.example.com",
        "cnameTo": "m.example.com.edgesuite.net"
      }
    ]
  }
}

Hostname Members

Member Type Required Description
cnameFrom String The original origin’s hostname.
cnameTo String The hostname for edge content, corresponding to the edge hostname object’s edgeHostnameDomain member.
cnameType Enumeration Only one supported EDGE_HOSTNAME value.
edgeHostnameId String A unique identifier for the edge hostname. See Data Conventions for details on how to omit the ID’s ehn_ prefix.

Rule

Specifies the executable logic to apply to cached edge content. The outer envelope’s rules object specifies the relevant top-level default rule object. See the Rules section for guidance on how to structure the data.

Sample GET response:

{
  "accountId": "act_1-1TJZFB",
  "contractId": "ctr_1-1TJZH5",
  "groupId": "grp_15225",
  "propertyId": "prp_173136",
  "propertyVersion": 3,
  "etag": "a9dfe78cf93090516bde891d009eaf57",
  "ruleFormat": "v2015-08-08",
  "rules": {
    "name": "default",
    "options": {
      "is_secure": false
    },
    "criteria": [],
    "behaviors": [
      {
        "name": "origin",
        "options": {
          "httpPort": 80,
          "enableTrueClientIp": false,
          "compress": true,
          "cacheKeyHostname": "ORIGIN_HOSTNAME",
          "forwardHostHeader": "REQUEST_HOST_HEADER",
          "hostname": "origin.test.com",
          "originType": "CUSTOMER"
        }
      },
      {
        "name": "cpCode",
        "options": {
          "value": {
            "id": 12345,
            "name": "my CP code"
          }
        }
      }
    ],
    "children": []
  }
}

Rule Members

Member Type Required Description
advancedOverride String A block of post-processing XML metadata that your Akamai representative can apply on your behalf. This must be configured separately for each property. Use the more recent customOverride member to apply the same XML metadata to more than one property.
behaviors Rule.behaviors[n] A series of behavior objects, which execute after the set of criteria evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.
children Object A series of nested Rule objects that execute after the current rule’s criteria and behaviors.
comment String A descriptive comment to help you track the rule’s function.
criteria Object A series of criteria objects, which form a set of logical tests that may prevent the rule’s behaviors from executing. Behavior and criteria objects are structured identically.
criteriaLocked Boolean Read-only. Within child rules, this prohibits any modifications to criteria objects. Contact your Akamai representative to change the value.
customOverride Rule.customOverride Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the List Custom Overrides operation, you can assign an overrideId to more than one property’s default rule. See Custom Behaviors and Overrides for guidance.
name String A description of the rule. The top-level rule must be named default.
options Rule.options Flags that apply to the top-level rule object.
uuid String A data hash that indicates the rule contains at least one advanced behavior or criteria, each identified with its own uuid member. When this member is present on the rule, you may not remove any advanced features it contains, or change their sequence. You must provide the same uuid value when modifying the rule tree. See Advanced and Locked Features.
variables Rule.variables[n] Declares a variable. See Declaring Variables for guidance on how variables may appear within a rule tree.

Rule.behaviors[n]  

A series of behavior objects, which execute after the set of criteria evaluates. Behavior and criteria objects are structured identically. Optional on nested rules.

Member Type Required Description
locked String Indicates a behavior or criteria that you arrange with your Akamai representative to lock so that you can’t modify it, typically to protect sensitive data from erroneous changes.
name String The name of the behavior.
options Object A variable set of options that configure each behavior. See Behaviors for details on each.
uuid String Read-only. A data hash that indicates an advanced behavior. When present, you may not modify the contents of the behavior, and must provide the same uuid value when modifying the rule tree. See Advanced and Locked Features.

Rule.customOverride  

Specifies post-processing XML metadata that your Akamai representative can create on your behalf. Once available with the List Custom Overrides operation, you can assign an overrideId to more than one property’s default rule. See Custom Behaviors and Overrides for guidance.

Member Type Required Description
name String The name of the custom override, which may vary from what appears in the List Custom Overrides operation’s response object.
overrideId String A unique identifier for the predefined custom override metadata you want to append to the current rule. See Data Conventions for details on how to omit the ID’s cbo_ prefix.

Rule.options  

Flags that apply to the top-level rule object.

Member Type Required Description
is_secure Boolean When enabled, serves the property’s content over SSL. Doing so may enable additional rule behaviors.

Rule.variables[n]  

Declares a variable. See Declaring Variables for guidance on how variables may appear within a rule tree.

Member Type Required Description
description String Text for you to keep track of how you use each variable.
hidden Boolean When enabled, the variable is suppressed from session response headers, often used to test content as described in the Debugging Variables section.
name String The underlying root name of the variable, which must be unique within the set of variables.
sensitive Boolean When enabled, the variable is suppressed from session responses as hidden ones, but it also can’t be invoked within any behaviors that assign values to cookies or response headers. You also can’t assign a sensitive variable to another one that is not sensitive, and you can’t add it to custom logging fields. Use this more stringent option for any personally identifiable information, typically after initially testing on the staging network.
value String Initializes a default value. Omitting this member initializes the variable with an empty string.

A query to search currently active properties. Only one query member is allowed in the POST request.

Sample POST request:

{
  "propertyName": "www.example.com_pm"
}

Search Members

Member Type Required Description
edgeHostname String Search for property versions active on a specific edge hostname.
hostname String Search for property versions active on a specific hostname.
propertyName String Search for properties by name.

Activation

Activates property versions on a specific network. Relevant response objects appear within the outer envelope’s activations.items array.

Sample POST request:

{
  "propertyVersion": 1,
  "network": "STAGING",
  "note": "Sample activation",
  "notifyEmails": [
    "you@example.com",
    "them@example.com"
  ],
  "acknowledgeWarnings": [
    "msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f"
  ],
  "useFastFallback": false
}

Sample GET response:

{
  "accountId": "act_1-1TJZFB",
  "contractId" : "ctr_1-CONTRACT",
  "groupId": "grp_15225",
  "activations": {
    "items": [
      {
        "activationId": "atv_1696985",
        "propertyName": "example.com",
        "propertyId": "prp_173136",
        "propertyVersion": 1,
        "network": "STAGING",
        "activationType": "ACTIVATE",
        "status": "PENDING",
        "submitDate": "2014-03-02T02:22:12Z",
        "updateDate": "2014-03-01T21:12:57Z",
        "note": "Sample activation",
        "notifyEmails": [
          "you@example.com",
          "them@example.com"
        ],
        "fmaActivationState" : "steady",
        "fallbackInfo" : {
            "fastFallbackAttempted" : false,
            "fallbackVersion" : 10,
            "canFastFallback" : true,
            "steadyStateTime" : 1506448172,
            "fastFallbackExpirationTime" : 1506451772,
            "fastFallbackRecoveryState" : null
        }
      }
    ]
  }
}

Activation Members

Member Type Required Description
accountId String Identifies the account under which the property activated. See Data Conventions for details on how to omit the ID’s act_ prefix.
acknowledgeAllWarnings Boolean When POSTing an activation, allows you to skip acknowledging each warning. With this enabled, you can omit the acknowledgeWarnings array.
acknowledgeWarnings Array A list of msg_-prefixed strings acknowledging any warnings noted in responses to previous activation requests.
activationId String The activation’s unique identifier. See Data Conventions for details on how to omit the ID’s atv_ prefix.
activationType Enumeration Either ACTIVATE or DEACTIVATE. The default is ACTIVATE. Any new activation automatically deactivates the current activation. Note that if you were to POST a DEACTIVATE type on an active property, it would no longer serve any traffic. You would need to modify (de-Akamaize) your DNS configuration and specify a different way to field the traffic.
fallbackInfo Activation.fallbackInfo Encapsulates information about fast fallback, which may allow you to fallback to a previous activation when POSTing an activation with useFastFallback enabled.
fastPush Boolean Enable a fast meta-data push when activating a new property, true by default.
fmaActivationState Enumeration Read-only. Indicates fast metadata activation state. A value of steady indicates the property is currently active or has been cancelled. Values of received, lived, and deployed represent progressive stages of activation, while cancelling happens either after failing a network safety check or in response to a DELETE operation. Note that the status member indicates whether the activation is live.
groupId String Identifies the group under which the property activated. See Data Conventions for details on how to omit the ID’s grp_ prefix.
ignoreHttpErrors Boolean Ignore any HTTP errors when pushing fast meta-data activation, true by default.
network Enumeration The network to activate on, either STAGING or PRODUCTION.
note String Assigns a log message to the activation request.
notifyEmails Array A list of email address strings to notify when the activation status changes.
propertyId String Identifies property targeted with activation. See Data Conventions for details on how to omit the ID’s prp_ prefix.
propertyName String The name of the property targeted with activation.
propertyVersion Integer The property version targeted with activation. Once activated, you can no longer modify that version of the property.
status Enumeration Either ACTIVE, INACTIVE, PENDING, ZONE_1, ZONE_2, ZONE_3, ABORTED, FAILED, DEACTIVATED, PENDING_DEACTIVATION, or NEW.
submitDate String Read-only. A date stamp marking when the activation initiated.
updateDate String Read-only. A date stamp marking when the status last changed.
useFastFallback Boolean After activating a property and finding it causes problems, POSTing another activation within one hour with useFastFallback enabled quickly rolls back to the previous version. This option is only available for activations where canFastFallback is true.

Activation.fallbackInfo  

Encapsulates information about fast fallback, which may allow you to fallback to a previous activation when POSTing an activation with useFastFallback enabled.

Member Type Required Description
canFastFallback Boolean Whether the current activation can fallback to a previous version. This is typically false for new properties, or for property versions whose set of hostnames has changed.
fallbackVersion Integer Indicates the property version that activates when a fast fallback succeeds.
fastFallbackAttempted Boolean Whether a fast fallback has already been attempted on this activation.
fastFallbackExpirationTime Integer Epoch second timestamp marking when fast fallback is no longer possible for this activation.
fastFallbackRecoveryState String, Null Represents additional information available for any attempted fallback.
propertyVersion Integer The version for which fast fallback may be available.
steadyStateTime Integer Epoch second timestamp marking when the activation completed, signaled by an fmaActivationState of steady.

CustomBehavior

Represents a customized XML metadata Akamai sets up on your behalf, and which you can invoke in a customBehavior within a rule tree. Relevant response objects appear within the outer envelope’s customBehaviors.items array. See Custom Behaviors and Overrides for guidance.

Sample GET response:

{
  "customBehaviors": {
    "items": [
      {
        "behaviorId": "cbe_12345",
        "name": "DLR",
        "displayName": "Custom Download Receipt",
        "description": "Setting custom download receipt. Uses PMUSER_LOG variable.",
        "status": "ACTIVE",
        "xml": "<reporting:edge-logging.send-receipt name=\"DLR\"><hostname>logs.customer.com</hostname><url>/dlr</url><allow-cacheh>off</allow-cacheh><status>on</status><port>443</port><format>stuff=%(PMUSER_LOG)&amp;time=%t&amp;url=%u</format><method>POST</method></reporting:edge-logging.send-receipt>",
        "updatedDate": "2017-04-24T12:34:56Z",
        "updatedByUser": "jsikkela"
      }
    ]
  }
}

CustomBehavior Members

Member Type Required Description
behaviorId String The unique identifier for the custom XML metadata that you reference from a customBehavior to insert it in a rule tree. See Data Conventions for details on how to omit the ID’s cbe_ prefix.
description String Descriptive text for the custom metadata.
displayName String A display label for the custom metadata.
name String A name for the custom metadata.
status Enumeration Current deployment status for the custom metadata. By the time it is available to customers, the only possible value is ACTIVE.
updatedByUser String The name of the Akamai representative who last updated the custom metadata.
updatedDate String The date stamp of the custom metadata’s latest update.
xml String The customized XML metadata to inject within the rule.

CustomOverride

Represents a customized XML metadata Akamai sets up on your behalf, and which you can invoke in a Rule.customOverride object within the top-level default rule tree to make it execute after all other rules, typically to restore a desired state. Relevant response objects appear within the outer envelope’s customOverrides.items array. See Custom Behaviors and Overrides for guidance on custom overrides.

Sample GET response:

{
  "customOverrides": {
    "items": [
      {
        "overrideId": "cbo_12345",
        "displayName": "MDC Behavior",
        "description": "Multiple Domain Configuration can be used to ...",
        "name": "mdc",
        "status": "ACTIVE",
        "updatedByUser": "jsikkela",
        "updatedDate": "2017-04-24T12:34:56Z",
        "xml": "<comment:info>This is where the XML goes</comment:info>"
      }
    ]
  }
}

CustomOverride Members

Member Type Required Description
description String Description for the custom override.
displayName String Display label for the custom override.
name String Name for the custom override.
overrideId String The unique identifier for the custom XML override that you reference from a Rule.customOverride object to append it to a rule tree. See Data Conventions for details on how to omit the ID’s cbo_ prefix.
status Enumeration Current deployment status for the custom override. By the time it is available to customers, the only possible value is ACTIVE.
updatedByUser String The name of the Akamai representative who last updated the custom override.
updatedDate String The date stamp of the custom metadata’s latest update.
xml String The customized XML metadata to append to the rule tree.

ClientSettings

Specifies default settings for an API client.

Sample GET response:

{
  "ruleFormat": "v2015-08-08",
  "usePrefixes": true
}

ClientSettings Members

Member Type Required Description
ruleFormat String A string key indicating the dated version of the API’s set of features specified by a rule format schema.
usePrefixes Boolean Whether ID values in response data should feature three-letter prefixes to indicate their type. You can set the PAPI-Use-Prefixes header to override the client’s default for each request. See Data Conventions for more information.

Build

Provides details on the software build. See the Build interface for details.

Sample GET response:

{
  "catalogGitInfo": {
    "buildDate": "2014-05-26T23:56:21Z",
    "commitDate": "2014-05-26T23:55:53Z",
    "branch": "candidate-14.2",
    "commitId": "59a193acdf26ba6de1522486411a749f19efde8c"
  },
  "coreGitInfo": {
    "buildDate": "2014-04-25T17:02:43Z",
    "commitDate": "2014-04-25T17:01:11Z",
    "branch": "14.2",
    "commitId": "22163903cb91a62492dfce745aaa95de991b0653"
  },
  "currentCatalogVersion": "14.2.6",
  "coreVersion": "14.2"
}

Build Members

Member Type Required Description
catalogGitInfo Build.catalogGitInfo Specifies internal tracking data.
coreGitInfo Build.coreGitInfo Specifies internal tracking data.
coreVersion String The Property Manager version.
currentCatalogVersion String The version of the Property Manager catalog that specifies rule behaviors and criteria. Note that this catalog is not the same as the rule format version available in the Rule Format Versions interface.

Build.catalogGitInfo  

Specifies internal tracking data.

Member Type Required Description
branch String The name of the build’s branch.
buildDate String When the code was built.
commitDate String When the final commit occurred.
commitId String An opaque data signature for the final commit.

Build.coreGitInfo  

Specifies internal tracking data.

Member Type Required Description
branch String The name of the build’s branch.
buildDate String When the code was built.
commitDate String When the final commit occurred.
commitId String An opaque data signature for the final commit.

Last modified: 10/10/2017