origin


Specify the hostname and settings used to contact the origin once service begins. You can use your own origin, Net​Storage, an Edge Load Balancing origin, or a Saa​S dynamic origin.

OptionTypeDescriptionRequires
origin​Typeenum

Choose where your content is retrieved from.

{"displayType":"enum","options":["CUSTOMER","NET_STORAGE","MEDIA_SERVICE_LIVE","EDGE_LOAD_BALANCING_ORIGIN_GROUP","SAAS_DYNAMIC_ORIGIN"],"tag":"select"}
CUSTOMER

From your own server.

NET_​STORAGE

From your Net​Storage account. This option is most appropriate for static content.

MEDIA_​SERVICE_​LIVE

From a Media Services Live origin.

EDGE_​LOAD_​BALANCING_​ORIGIN_​GROUP

From any available Edge Load Balancing origin.

SAAS_​DYNAMIC_​ORIGIN

From a Saa​S dynamic origin if Saa​S acceleration is available on your contract.

net​Storageobject

Specifies the details of the Net​Storage server.

origin​Type is NET_​STORAGE
{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"originType","op":"eq","value":"NET_STORAGE"}}
net​Storage.cp​Codeinteger

Identifies a CP code assigned to this storage group.

net​Storage.download​Domain​Namestring

Domain name from which content can be downloaded.

net​Storage.g2o​Tokenstring

Signature Header Authentication key.

net​Storage.idinteger

Unique identifier for the storage group.

net​Storage.namestring

Name of the storage group.

origin​Idstring

Identifies the Edge Load Balancing origin. This needs to correspond to an edge​Load​Balancing​Origin behavior's id attribute within the same property.

origin​Type is EDGE_​LOAD_​BALANCING_​ORIGIN_​GROUP
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"originType","op":"eq","value":"EDGE_LOAD_BALANCING_ORIGIN_GROUP"}}
hostnamestring (allows variables)

Specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.

origin​Type is CUSTOMER
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"originType","op":"eq","value":"CUSTOMER"}}
second​Hostname​Enabledboolean

Available only for certain products. This specifies whether you want to use an additional origin server address.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"and","params":[{"attribute":"hostname","op":"type","value":["ipv4_address","ipv6_address"]},{"attribute":"productName","op":"in","scope":"global","value":["API_Accel"]}]}}
second​Hostnamestring (allows variables)

Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.

second​Hostname​Enabled is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"secondHostnameEnabled","op":"eq","value":true}}
msloriginstring

This specifies the media's origin server.

origin​Type is MEDIA_​SERVICE_​LIVE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"originType","op":"eq","value":"MEDIA_SERVICE_LIVE"}}
saas​Typeenum

Specifies the part of the request that identifies this Saa​S dynamic origin.

origin​Type is SAAS_​DYNAMIC_​ORIGIN
{"displayType":"enum","options":["HOSTNAME","PATH","QUERY_STRING","COOKIE"],"tag":"select"}
{"if":{"attribute":"originType","op":"eq","value":"SAAS_DYNAMIC_ORIGIN"}}
Supported values:
COOKIE
HOSTNAME
PATH
QUERY_STRING
saas​Cname​Enabledboolean

Enabling this allows you to use a CNAME chain to determine the hostname for this Saa​S dynamic origin.

saas​Type is HOSTNAME
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"saasType","op":"eq","value":"HOSTNAME"}}
saas​Cname​Levelnumber

Specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.

saas​Cname​Enabled is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"saasCnameEnabled","op":"eq","value":true}}
saas​Query​Stringstring

Specifies the name of the query parameter that identifies this Saa​S dynamic origin.

saas​Type is QUERY_​STRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"saasType","op":"eq","value":"QUERY_STRING"}}
saas​Regexstring

Specifies the Perl-compatible regular expression match that identifies this Saa​S dynamic origin.

origin​Type is SAAS_​DYNAMIC_​ORIGIN
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"originType","op":"eq","value":"SAAS_DYNAMIC_ORIGIN"}}
saas​Replacestring

Specifies replacement text for what saas​Regex matches.

origin​Type is SAAS_​DYNAMIC_​ORIGIN
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"originType","op":"eq","value":"SAAS_DYNAMIC_ORIGIN"}}
saas​Suffixstring

Specifies the static part of the Saa​S dynamic origin.

origin​Type is SAAS_​DYNAMIC_​ORIGIN
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"originType","op":"eq","value":"SAAS_DYNAMIC_ORIGIN"}}
forward​Host​Headerenum

When the origin​Type is set to either CUSTOMER or SAAS_​DYNAMIC_​ORIGIN, this specifies which Host header to pass to the origin.

origin​Type is either: CUSTOMER, SAAS_​DYNAMIC_​ORIGIN
{"displayType":"enum","options":["REQUEST_HOST_HEADER","ORIGIN_HOSTNAME","CUSTOM"],"tag":"select"}
{"if":{"attribute":"originType","op":"in","value":["CUSTOMER","SAAS_DYNAMIC_ORIGIN"]}}
REQUEST_​HOST_​HEADER

Passes the original request's header.

ORIGIN_​HOSTNAME

Passes the current origin's HOSTNAME.

CUSTOM

Passes the value of custom​Forward​Host​Header. Use this option if you want requests handled by different properties to converge on the same cached object.

custom​Forward​Host​Headerstring (allows variables)

This specifies the name of the custom host header the edge server should pass to the origin.

forward​Host​Header is CUSTOM
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"forwardHostHeader","op":"eq","value":"CUSTOM"}}
cache​Key​Hostnameenum

Specifies the hostname to use when forming a cache key.

origin​Type is either: CUSTOMER, SAAS_​DYNAMIC_​ORIGIN
{"displayType":"enum","options":["REQUEST_HOST_HEADER","ORIGIN_HOSTNAME"],"tag":"select"}
{"if":{"attribute":"originType","op":"in","value":["CUSTOMER","SAAS_DYNAMIC_ORIGIN"]}}
REQUEST_​HOST_​HEADER

Specify when using a virtual server.

ORIGIN_​HOSTNAME

Specify if your origin server's responses do not depend on the hostname.

ip​Versionenum

Specifies which IP version to use when getting content from the origin.

origin​Type is either: CUSTOMER, EDGE_​LOAD_​BALANCING_​ORIGIN_​GROUP
{"displayType":"enum","options":["IPV4","DUALSTACK","IPV6"],"tag":"select"}
{"if":{"op":"and","params":[{"attribute":"originType","op":"in","value":["CUSTOMER","EDGE_LOAD_BALANCING_ORIGIN_GROUP"]},{"attribute":"productName","op":"in","scope":"global","value":["Adaptive_Media_Delivery","Download_Delivery","Obj_Delivery","Fresca","SPM","Site_Accel","API_Accel"]}]}}
IPV4

Use IPv4.

DUALSTACK

Use both versions.

IPV6

Use IPv6.

use​Unique​Cache​Keyboolean

With a shared hostname such as provided by Amazon AWS, sets a unique cache key for your content.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"and","params":[{"attribute":"hostname","op":"in","value":["s3.amazonaws.com","s3-eu-west-1.amazonaws.com","s3-ap-southeast-1.amazonaws.com","s3-ap-northeast-1.amazonaws.com","s3-us-west-2.amazonaws.com","s3-us-west-1.amazonaws.com","s3-ap-southeast-2.amazonaws.com","s3.eu-central-1.amazonaws.com","s3-eu-central-1.amazonaws.com","s3.ap-south-1.amazonaws.com","s3.eu-west-2.amazonaws.com","s3.cn-north-1.amazonaws.com.cn","s3-website-us-east-1.amazonaws.com","s3.ap-northeast-2.amazonaws.com"]},{"attribute":"cacheKeyHostname","op":"eq","value":"ORIGIN_HOSTNAME"}]}}
compressboolean

Enables gzip compression for non-Net​Storage origins.

origin​Type is either: CUSTOMER, EDGE_​LOAD_​BALANCING_​ORIGIN_​GROUP, SAAS_​DYNAMIC_​ORIGIN
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"originType","op":"in","value":["CUSTOMER","EDGE_LOAD_BALANCING_ORIGIN_GROUP","SAAS_DYNAMIC_ORIGIN"]}}
enable​True​Client​Ipboolean

When enabled on non-Net​Storage origins, allows you to send a custom header (the true​Client​Ip​Header) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.

origin​Type is either: CUSTOMER, EDGE_​LOAD_​BALANCING_​ORIGIN_​GROUP, SAAS_​DYNAMIC_​ORIGIN
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"originType","op":"in","value":["CUSTOMER","EDGE_LOAD_BALANCING_ORIGIN_GROUP","SAAS_DYNAMIC_ORIGIN"]}}
true​Client​Ip​Headerstring

This specifies the name of the field that identifies the end client's IP address, for example True-Client-IP.

enable​True​Client​Ip is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enableTrueClientIp","op":"eq","value":true}}
true​Client​Ip​Client​Settingboolean

If a client sets the True-Client-IP header, the edge server allows it and passes the value to the origin. Otherwise the edge server removes it and sets the value itself.

enable​True​Client​Ip is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enableTrueClientIp","op":"eq","value":true}}
verification​Modeenum

For non-Net​Storage origins, maximize security by controlling which certificates edge servers should trust.

origin​Type is either: CUSTOMER, EDGE_​LOAD_​BALANCING_​ORIGIN_​GROUP, SAAS_​DYNAMIC_​ORIGIN
{"displayType":"enum","options":["PLATFORM_SETTINGS","CUSTOM","THIRD_PARTY"],"tag":"select"}
{"if":{"attribute":"originType","op":"in","value":["CUSTOMER","EDGE_LOAD_BALANCING_ORIGIN_GROUP","SAAS_DYNAMIC_ORIGIN"]}}
PLATFORM_​SETTINGS

Trust platform settings.

CUSTOM

Only applies if the property is marked as secure. See Secure property requirements for guidance. Under some products, you may also need to enable the Secure Delivery - Customer Cert module. See the verification settings in the Origin Server behavior or contact your Akamai representative for details.

THIRD_​PARTY

When your origin server references certain types of third-party hostname.

origin​Sniboolean

For non-Net​Storage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. See the verification settings in the Origin Server behavior or contact your Akamai representative for more information. If you want to use TLS version 1.​3 in your existing properties, enable this option. New properties have this enabled by default.

origin​Type is either: CUSTOMER, EDGE_​LOAD_​BALANCING_​ORIGIN_​GROUP, SAAS_​DYNAMIC_​ORIGIN
AND verification​Mode is either: PLATFORM_​SETTINGS, CUSTOM, THIRD_​PARTY
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"and","params":[{"attribute":"originType","op":"in","value":["CUSTOMER","EDGE_LOAD_BALANCING_ORIGIN_GROUP","SAAS_DYNAMIC_ORIGIN"]},{"attribute":"verificationMode","op":"in","value":["PLATFORM_SETTINGS","CUSTOM","THIRD_PARTY"]}]}}
custom​Valid​Cn​Valuesstring array

Specifies values to look for in the origin certificate's Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)

verification​Mode is CUSTOM
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"verificationMode","op":"eq","value":"CUSTOM"}}
origin​Certs​To​Honorenum

Specifies which certificate to trust.

verification​Mode is CUSTOM
{"displayType":"enum","options":["COMBO","STANDARD_CERTIFICATE_AUTHORITIES","CUSTOM_CERTIFICATE_AUTHORITIES","CUSTOM_CERTIFICATES"],"tag":"select"}
{"if":{"attribute":"verificationMode","op":"eq","value":"CUSTOM"}}
COMBO

May rely on all three other inputs.

STANDARD_​CERTIFICATE_​AUTHORITIES

Any certificate signed by an Akamai-managed authority set.

CUSTOM_​CERTIFICATE_​AUTHORITIES

Any certificate signed by a custom authority set you manage.

CUSTOM_​CERTIFICATES

Pinned origin server certificates.

custom​Certificate​Authoritiesobject array

Specifies an array of certification objects. See the verification settings in the Origin Server behavior or contact your Akamai representative for details on this object's requirements.

origin​Certs​To​Honor is either: CUSTOM_​CERTIFICATE_​AUTHORITIES, COMBO
{"displayType":"object array","tag":"input","todo":true}
{"if":{"attribute":"originCertsToHonor","op":"in","value":["CUSTOM_CERTIFICATE_AUTHORITIES","COMBO"]}}
custom​Certificatesobject array

Specifies an array of certification objects. See the verification settings in the Origin Server behavior or contact your Akamai representative for details on this object's requirements.

origin​Certs​To​Honor is either: CUSTOM_​CERTIFICATES, COMBO
{"displayType":"object array","tag":"input","todo":true}
{"if":{"attribute":"originCertsToHonor","op":"in","value":["CUSTOM_CERTIFICATES","COMBO"]}}
http​Portnumber

Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.

origin​Type is either: CUSTOMER, SAAS_​DYNAMIC_​ORIGIN
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"originType","op":"in","value":["CUSTOMER","SAAS_DYNAMIC_ORIGIN"]}}
https​Portnumber

Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.

origin​Type is either: CUSTOMER, SAAS_​DYNAMIC_​ORIGIN
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"originType","op":"in","value":["CUSTOMER","SAAS_DYNAMIC_ORIGIN"]}}
min​Tls​Versionenum

Specifies the minimum TLS version to use for connections to your origin server.

origin​Type is either: CUSTOMER, MEDIA_​SERVICE_​LIVE
{"displayType":"enum","options":["DYNAMIC","TLSV1_1","TLSV1_2","TLSV1_3"],"tag":"select"}
{"if":{"op":"and","params":[{"expression":{"op":"or","params":[{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"TLS_1_3_Opt_Out"},{"attribute":"property.modulesOnContract","op":"contains","scope":"global","value":"TLS_1_3_Opt_Out"}]},"op":"not"},{"attribute":"originType","op":"in","value":["CUSTOMER","MEDIA_SERVICE_LIVE"]},{"op":"or","params":[{"attribute":"property.productName","op":"in","scope":"global","value":["Adaptive_Media_Delivery","API_Accel","Download_Delivery","Fresca","Obj_Delivery","RM","Site_Accel","SPM"]},{"attribute":"productName","op":"in","scope":"global","value":["Adaptive_Media_Delivery","API_Accel","Download_Delivery","Fresca","Obj_Delivery","RM","Site_Accel","SPM"]}]}]}}
DYNAMIC

Supports all currently public versions of TLS.

TLSV1_1

Supports TLS version 1.​1.

TLSV1_2

Supports TLS version 1.​2.

TLSV1_3

Supports TLS version 1.​3. This behavior supports TLS 1.​3 by default.

max​Tls​Versionenum

Specifies the maximum TLS version to use for connections to your origin server. As best practice, use DYNAMIC to automatically apply the latest supported version.

origin​Type is either: CUSTOMER, MEDIA_​SERVICE_​LIVE
{"displayType":"enum","options":["DYNAMIC","TLSV1_1","TLSV1_2","TLSV1_3"],"tag":"select"}
{"if":{"op":"and","params":[{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"Max_TLS_Trial"},{"attribute":"originType","op":"in","value":["CUSTOMER","MEDIA_SERVICE_LIVE"]},{"expression":{"op":"or","params":[{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"TLS_1_3_Opt_Out"},{"attribute":"property.modulesOnContract","op":"contains","scope":"global","value":"TLS_1_3_Opt_Out"}]},"op":"not"}]}}
DYNAMIC

Automatically applies the latest supported version.

TLSV1_1

Supports TLS version 1.​1.

TLSV1_2

Supports TLS version 1.​2.

TLSV1_3

Supports TLS version 1.​3. This behavior supports TLS 1.​3 by default.

http2Enabledboolean

TBD

origin​Type is either: CUSTOMER
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"and","params":[{"attribute":"originType","op":"in","value":["CUSTOMER"]},{"op":"or","params":[{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"Origin_HTTP2_Trial"},{"attribute":"property.modulesOnContract","op":"contains","scope":"global","value":"Origin_HTTP2_Trial"}]}]}}