Today we’re announcing PAPI GA (General Availability). For all you early adopters, we appreciate your patience; you helped us make it faster and better. We know the wait is worth it!
The Property Manager API, or PAPI, lets you programmatically manage the configuration of your web content on the Akamai intelligent platform, a highly distributed cloud of 175,000+ servers in 1,300+ networks and 100+ countries.
PAPI GA Improvements
There are several improvements you should be aware of in PAPI v1:
Performance – We’ve improved performance in general over the past few months, especially for large complex configurations. And while certain operations, like validation, can still take a rather long time, the vast majority of PAPI calls are now completed in a reasonable time. New endpoints and options (see below), also allow you to make far fewer PAPI calls to achieve what you want, speeding up your applications. We’ll be making further performance improvements in the next few months.
Search – There is now a configuration search endpoint, allowing you to get the property ID directly if you know the property name, hostname or edge hostname. You no longer have to traverse the entire group hierarchy to find a particular property!
Acknowledgement of Warnings – We introduced a flag “acknowledgeAllWarnings” that allows you to skip the separate PAPI call to acknowledge individual warnings before you can activate a property. We still provide the list of warnings, but there is no need for you to programmatically acknowledge each one of them!
Defer Validation – Optional parameter for PUT to defer property validation. You still have to validate successfully before activating a property.
Ignore HTTP Errors – You can choose to ignore HTTP errors during the activation, when using fast activation. Note that fast activation is still in LA (Limited Availability).
Version Note Field – Is now supported, so you can add comments to a new property version.
uuid Optional – The uuid is now optional, except for locked behaviors and their parent rules.
Rate Limiting – To protect the platform and ensure availability for all customers, we’ll be implementing some reasonable rate limits. You should avoid generating more than 8 PAPI requests/sec over a 5 second window, and 4 PAPI requests/sec over a 2 minute window.
Flexible Resource Limits – If you run into any of our Property Manager resource limits, such as # of activations/day, # of properties, # of rules, etc, please reach out to akatec or your account team to see if the limits can be increased for your use cases.
Credentials – Be aware that PAPI currently only supports Open credentials assigned to one group. This issue will be addressed shortly, but in the meantime, if your PAPI application needs to access properties (configs) in multiple groups, you should put the Open credential in a top level group.
New Rule-Format – The use of rule formats are critical to ensure application reliability as it locks down the feature set to a point in time. From time to time you should update your code to use the most recent rule format to get access to the latest features and bug fixes. We have a new rule format “2017-06-19” coming at the end of June 2017, which includes a lot of important improvements, such as:
- Additional built-in variables, new variable matching operators (<, <=, >, >=) and variable support for several new features.
- Custom log field support.
- Origin behavior now supports the new Media Services Live origin.
- The upcoming Custom Behavior functionality, aka Advanced Metadata Reuse.
- + All the latest products and modules.
- Performance – We realize that performance is critical and further PAPI performance improvements will be rolled out later this year.
- Separate Validation Endpoint – A separate endpoint allowing you to validate a property rule tree without creating a new version of the property.
- More Search – Additional property search options, including edit/activation time, allowing you to retrieve configs that have changed since a certain time.
- Custom Behaviors – Custom Behaviors, aka Advanced Metadata Reuse, is coming very soon.
- Secure Edge Hostnames – Support for creating secure edge hostnames.
- CPCodes – Improved support for cpcode creation.
- New Open APIs – Separate Open APIs for managing your edge hostnames, cpcodes and reporting groups are also coming later this year.
If you’ve been using the PAPI v0 beta, please start using the PAPI v1 endpoints and refactor your code to take advantage of the new features and improvements. PAPI v1 is backwards compatible with v0, so your code will work as before. A deprecation notice for PAPI v0 will be posted in early July, 2017, and the v0 endpoints will continue working until January, 2018.
Check github.com/akamai-open for sample code, especially the Akamai CLI for Property Manager, which has an easy to use command line interface for common DevOps tasks, as well as a library you can embed in your apps.
Review the updated PAPI documentation.
Stay Up to Date
- Check the new Akamai for DevOps site, your portal for all things DevOps.
- If you haven’t already, please register on developer.akamai.com for important developer updates, events, and release information.
- Visit the developer space on the Akamai community for support.
- Please give us your feedback once you have had a chance to implement PAPI v1.