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"]},{"op":"or","params":[{"op":"and","params":[{"attribute":"productName","op":"in","scope":"global","value":["Adaptive_Media_Delivery","Download_Delivery","Obj_Delivery","Fresca","SPM","Site_Accel"]},{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"OriginIPACL_Trial"}]},{"attribute":"productName","op":"in","scope":"global","value":["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.

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"]}}
tls13Supportboolean

Enables transport layer security (TLS) version 1.‚Äč3 for connections to your origin server.

origin‚ÄčType is either: CUSTOMER, MEDIA_‚ÄčSERVICE_‚ÄčLIVE
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"and","params":[{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"TLS_1_3_Trial"},{"attribute":"originType","op":"in","value":["CUSTOMER","MEDIA_SERVICE_LIVE"]}]}}
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":[{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"TLS_1_3_Trial"},{"attribute":"originType","op":"in","value":["CUSTOMER","MEDIA_SERVICE_LIVE"]}]}}
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.

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"]}]}}
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.