API

Concepts

Familiarize yourself with some of the common terms used in this API:

  • Access keys. Long-term credentials that you use to sign and authenticate requests to these cloud providers. An access key consists of an access key identifier and a secret access key. If you want to use ​Akamai​ Object Storage as the origin, you can Create an access key in the CAM API or the interface. When you create an access key with your cloud provider, you create the access key identifier and secret access key as a set.
    Use this API to store your long-term credentials as an access key. You use an access key to sign and authenticate requests to these cloud providers. An access key is a combination of the access key ID and secret access key with AWS, or the access ID and secret for GCS.

  • Contracts. Each account features one or more contracts, each of which has a fixed term of service during which specified Akamai products and modules are active. You need a contract's unique contractId to access some of the CAM API's operations. See Get started for details on obtaining this value.

  • Groups. Each account features a hierarchy of groups, which control access to Property Manager properties and help consolidate reporting functions, typically mapping to an organizational hierarchy. Using either Control Center or the Identity and Access Management API, account administrators can assign properties to specific groups, each with its own set of users and accompanying roles. Your access to any given property depends on the role set for you in its group. You need a group's groupId to access some of the CAM API's operations. See Get started for details on obtaining this value.

  • PCI-compliant. An enhanced, secure deployment network that provides TLS and HTTPS functionality. It meets the security standards required to deliver payment card industry (PCI) data. For more information on how this network delivers content, see "Enhanced TLS" in a comparison of TLS offerings.

📘

To use this deployment network with your access keys, your contract needs to support serving traffic with Enhanced TLS certificates. Also, you need to create an Enhanced TLS certificate for your hostnames in the Certificate Provisioning System and select that certificate when adding these hostnames to your property. See Create and edit certificates.

  • PCI-noncompliant. A standard, secure deployment network that provides TLS and HTTPS functionality. While it's secure, it doesn't support delivery of PCI data. For more information on how this network delivers content, see "Standard TLS" in a comparison of TLS offerings.

  • Property. The individual property in Property Manager where you assign an access key. You set up a rule in this property with relevant match criteria for requests and configure the Origin Characteristics or any other relevant behavior in that rule to apply the key.

  • Version. The version of an access key. You can rotate an access key to a new version and you can have up to two versions of a single access key.