Recipes

xxxxxxxxxx

contractId="ctr_1-ABCDEF"

groupId="grp_12345"

​

egcurl --eg-section default --request POST \

​

  --url "https://$hostname/papi/v1/properties?contractId=$contractId&groupId=$groupId" \

  --header "Accept: application/json"

  --header "PAPI-Use-Prefixes: true"

 \

  --header "Content-Type: application/json" \

  --data '

{

    "productId": "prd_Alta",

    "propertyName": "docsassociates.com",

    "ruleFormat": "latest"

}'

• Create a new property

  Use this operation to create a new property from scratch.

  8 steps

  Open Recipe

• List groups

  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.

  5 steps

  Open Recipe

• List contracts

  You need information about the prevailing contract to access most PAPI interfaces. This operation provides a read-only list of contract names and identifiers.

  5 steps

  Open Recipe

• List products

  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.

  6 steps

  Open Recipe

• List use cases

  For a given product, this operation 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.

  6 steps

  Open Recipe

• List CP codes

  This operation lists content provider (CP) codes available within your contract and group pairing, which you assign to a property within its rule tree.

  A CP code is a unique identifier that ​Akamai​ uses for billing and reports for the traffic delivered through your property.

  6 steps

  Open Recipe

• Create a new CP code

  Use this operation to create a new content provider (CP) code and associate it with a product, for use in creating properties.

  8 steps

  Open Recipe

• Get a CP code

  This operation gets details about a specific content provider (CP) code.

  6 steps

  Open Recipe

• List edge hostnames

  This operation lists all edge hostnames available under a contract.

  6 steps

  Open Recipe

• Get an edge hostname

  This operation polls the state of an edge hostname. It can be useful after you create one to see if it's ready for use.

  8 steps

  Open Recipe

• Create a Standard TLS edge hostname

  Use this operation to create a new secure edge hostname using Standard TLS.

  Start here if you're using the CPS-managed certificate method and Standard TLS to secure the connection between a requesting client and the ​Akamai​ edge network.

  12 steps

  Open Recipe

• Create an Enhanced TLS edge hostname

  Use this operation to create a new secure edge hostname using Enhanced TLS.

  Start here if you're using the CPS-managed certificate method and Enhanced TLS to secure the connection between a requesting client and the ​Akamai​ edge network.

  13 steps

  Open Recipe

• Create a Shared Certificate edge hostname

  Use this operation to create a secure edge hostname using Akamai's shared certificate hostname.

  Start here if you're using ​Akamai​'s shared certificate to secure the connection between a requesting client and the ​​Akamai​​ edge network.

  10 steps

  Open Recipe

• List properties

  This operation lists properties available for a specified ​Akamai​ contract and group.

  6 steps

  Open Recipe

• Clone a property

  Use this operation to create a new property and base it on another property's rule tree (and optionally, its set of assigned hostnames).

  9 steps

  Open Recipe

• Get a property

  This operation gets a specific property.

  7 steps

  Open Recipe

• Remove a property

  Removes a specific property. You can only run this operation if none of the property's versions are currently active.

  6 steps

  Open Recipe

• List property versions

  Use this operation to list the property’s versions, with results limited to the 500 most recent versions.

  7 steps

  Open Recipe

• Create a new property version

  Create a new property version based on any previous version.

  10 steps

  Open Recipe

• Get a property version

  This polls the state of a specific property version, for example to check its activation status.

  8 steps

  Open Recipe

• Get the latest property version

  This operation provides either the latest property version overall, or the latest version that's active on the production or staging networks.

  7 steps

  Open Recipe

• List available behaviors for a property

  This operation lists the set of behaviors you may apply within a property version's rules.

  8 steps

  Open Recipe

• List available criteria for a property

  Lists the set of criteria you may apply within a property version's rules.

  8 steps

  Open Recipe

• List hostnames for a property version

  This operation lists all hostnames whose requests are handled by the rules in this property version.

  8 steps

  Open Recipe

• Update a property with a Default DV certificate hostname

  Use this to initially secure your property with a secure edge hostname that's using the Default DV certificate method.

  10 steps

  Open Recipe

• Update a property with a CPS-managed certificate hostname

  Use this to initially secure your property with an edge hostname that's been secured with a CPS-managed certificate that uses Standard TLS or Enhanced TLS.

  12 steps

  Open Recipe

• Update a property with a CCM certificate hostname

  Use this to initially secure your property with an edge hostname that's been secured with a CCM certificate that uses Standard TLS or Enhanced TLS.

  12 steps

  Open Recipe

• Update a property with a shared certificate hostname

  Use this to initially secure your property with an edge hostname that's been secured using ​Akamai​'s shared certificate.

  12 steps

  Open Recipe

• Add a hostname to an existing property

  Use this to add more property hostnames to an existing version of a property.

  11 steps

  Open Recipe

• Remove a hostname from an existing property

  Use this to remove a property hostname from an existing version of a property.

  11 steps

  Open Recipe

• Get a property rule tree

  Gets the entire rule tree for a property version.

  8 steps

  Open Recipe

• Update a property's rule tree

  Use this operation to update the entire rule tree for a property version.

  10 steps

  Open Recipe

• Patch a rule tree

  Use this operation to selectively modify the rules and behaviors in your tree using JSON patch syntax.

  7 steps

  Open Recipe

• List activations

  This lists all activations for all versions of a property, on both production and staging networks.

  6 steps

  Open Recipe

• Get an activation

  This operation gets details about an activation. You typically poll its status to check when an activated property version goes live.

  6 steps

  Open Recipe

• List bulk search results

  List all property versions that result from a bulk search request. Run this operation to poll the asynchronous process's status.

  6 steps

  Open Recipe

• Activate a property version

  This operation creates a new property activation, which deactivates any current activation. Optionally also call this operation to perform a fast fallback to the previously activated version.

  12 steps

  Open Recipe

• Cancel a pending property activation

  If you detect a problem with a property version while its activation is still PENDING, you can use this operation to cancel it.

  5 steps

  Open Recipe

• Search properties

  Use this operation to search properties either by name, hostname, or the currently active edge hostname.

  6 steps

  Open Recipe

• Bulk search a set of properties

  Use this operation to search across all active property versions, specifying a JSONPath expression to match their rule trees. This operation launches an asynchronous process to gather search results.

  7 steps

  Open Recipe

• List hostnames for an account

  This operation lists active property hostnames for all properties available in an account.

  6 steps

  Open Recipe

• Create a hostname bucket property

  This type of property supports thousands of hostnames.

  8 steps

  Open Recipe

• Generate certificate domain validation challenges

  If you're using Default DV certificates, you can validate the ownership of the domain ahead of setting hostnames for your property. This significantly speeds up the certificate deployment process.

  6 steps

  Open Recipe

• Add or remove hostnames for a property's hostname bucket

  Use this operation to add up to 1,000 property hostnames without incrementing the property version. See also Add a hostname to an existing property

  9 steps

  Open Recipe

• List hostname activations

  For a property with useHostnameBucket set to true at creation, this lists the activations for all hostnames in the property's hostname bucket, on both production and staging networks.

  7 steps

  Open Recipe

• Get a property hostname activation

  For a property with useHostnameBucket set to true at creation, this operation gets details about a specific property hostname activation.

  7 steps

  Open Recipe

• Cancel a pending property hostname activation

  For a property with useHostnameBucket set to true at creation, if you detect a problem with a property hostname while its activation is still PENDING, this operation allows you to cancel it.

  6 steps

  Open Recipe

• List hostnames for a property

  This operation lists active property hostnames associated with a specific property.

  7 steps

  Open Recipe

• Get audit history for property hostnames

  Gets a detailed record of all modifications made to a property hostname.

  6 steps

  Open Recipe

• Get property hostnames diff

  For a property with useHostnameBucket set to true at creation, this operation lists active property hostnames whose details differ between the staging and production networks.

  7 steps

  Open Recipe

• Create an include

  This operation either creates a new include from scratch or bases one on another include's rule tree. Version 1 of a new include is created automatically.

  9 steps

  Open Recipe

• Update an include's rule tree

  Use this operation to update the entire rule tree for a include version.

  10 steps

  Open Recipe

• Activate an include

  This operation creates a new include activation, which deactivates any current activation. After a necessary delay, this activates your version's rule tree modifying how your edge content responds to end-user requests.

  11 steps

  Open Recipe

• List include's activations

  This lists all activations for all versions of an include, on both production and staging networks.

  6 steps

  Open Recipe

• Get an include activation

  Gets details about an activation. The response also shows the results of include validations against the active parent properties' rule trees where the include is referenced.

  6 steps

  Open Recipe

• List includes

  This operation lists includes available for the current contract and group.

  6 steps

  Open Recipe

• Get an include

  This operation gets a specific include. You can call this operation by specifying any of the includeId members from a list of includes, or by running a GET on the includeLink response when creating a new include.

  7 steps

  Open Recipe

• List parent properties

  Lists all active properties a specific include is referenced in. Use the optional query parameters to paginate, sort, and filter the results.

  7 steps

  Open Recipe

• List include versions

  Lists the include's versions, with results limited to the 500 most recent versions. Each include version indicates activation status on different networks, and an etag digest useful when cloning the include.

  7 steps

  Open Recipe

• Get the latest include version

  This operation provides either the latest include version overall, or the latest one active on the production or staging networks. By default, the response yields the include version with the highest number.

  7 steps

  Open Recipe

• Get an include version

  This polls the state of a specific include version, for example to check its activation status.

  8 steps

  Open Recipe

• List available behaviors for an include

  Lists the set of behaviors you may apply within an include 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.

  8 steps

  Open Recipe

• List available criteria for an include

  Lists the set of criteria you may apply within an include 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.

  8 steps

  Open Recipe

• Get an include's rule tree

  Gets the entire rule tree for an include version. See the Rule Trees section for details on the response object's structure.

  8 steps

  Open Recipe

• Clone an include

  Use this operation to create a new include and base it on another include's rule tree.

  9 steps

  Open Recipe

• Create a new include version

  Create a new include version based on any previous version. All data from the createFromVersion populates the new version.

  10 steps

  Open Recipe

• Remove an include

  Removes a specific include, which you can only do if none of its versions are currently active.

  6 steps

  Open Recipe

• Cancel a pending include activation

  If you detect a problem with an include version while its activation is still PENDING, this operation allows you to cancel it.

  5 steps

  Open Recipe

• Patch an include's rule tree

  Selectively modify a rule tree using JSON patch syntax. As a component of the larger Bulk patch a set of includes, this operation patches an individual rule tree. See Bulk Search and Update for more information.

  7 steps

  Open Recipe

• Resume domain validation

  If you're using Default Domain Validation (DV) certificates, some domains validated using either manual HTTP or manual DNS method can return the PAUSED_AWAITING_PROCEED authorization status in the GET response. Run this operation to resume the validation process for these domains.

  8 steps

  Open Recipe

• List hostnames for a property (advanced domain validation)

  This operation lists active property hostnames associated with a specific property.

  7 steps

  Open Recipe

• List hostnames for a property version (advanced domain validation)

  This operation lists all hostnames whose requests are handled by the rules in this property version.

  8 steps

  Open Recipe