GuideReference
TrainingSupportCommunity

origin_​characteristics


Specifies characteristics of the origin. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.

See also client​_characteristics and various product-specific behaviors whose names are prefixed content​Characteristics.

OptionTypeDescriptionRequires
countryenum

Specifies the origin's geographic region.

{"displayType":"enum","options":["EUROPE","NORTH_AMERICA","LATIN_AMERICA","SOUTH_AMERICA","NORDICS","ASIA_PACIFIC","OTHER_AMERICAS","OTHER_APJ","OTHER_EMEA","AUSTRALIA","GERMANY","INDIA","ITALY","JAPAN","MEXICO","TAIWAN","UNITED_KINGDOM","US_EAST","US_CENTRAL","US_WEST","GLOBAL_MULTI_GEO","OTHER","UNKNOWN","ADC"],"tag":"select"}
EUROPE

Europe.

NORTH_​AMERICA

North America.

LATIN_​AMERICA

Latin America.

SOUTH_​AMERICA

South America.

NORDICS

Northern Europe.

ASIA_​PACIFIC

Asia and Pacific Islands.

OTHER_​AMERICAS

Other Americas.

OTHER_​APJ

Asia, Pacific, Japan.

OTHER_​EMEA

Europe, Middle East, Africa.

AUSTRALIA

Australia.

GERMANY

Germany.

INDIA

India.

ITALY

Italy.

JAPAN

Japan.

MEXICO

Mexico.

TAIWAN

Taiwan.

UNITED_​KINGDOM

United Kingdom.

US_​EAST

Eastern United States.

US_​CENTRAL

Central United States.

US_​WEST

Western United States.

GLOBAL_​MULTI_​GEO

Global.

OTHER

A fallback value.

UNKNOWN

Defer this optimization.

ADC

Akamai Direct Connection, available to Adaptive Media Delivery customers.

direct_​connect_​geostring

Provides a region used by Akamai Direct Connection.

country is ADC
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"country","op":"eq","value":"ADC"}}
authentication_​methodenum

Specifies the authentication method.

{"displayType":"enum","options":["AUTOMATIC","SIGNATURE_HEADER_AUTHENTICATION","MSL_AUTHENTICATION","AWS","GCS_HMAC_AUTHENTICATION"],"tag":"select"}
AUTOMATIC

Use default authentiation.

SIGNATURE_​HEADER_​AUTHENTICATION

Available with the Adaptive Media Delivery product.

MSL_​AUTHENTICATION

Available with the Adaptive Media Delivery product.

AWS

Amazon Web Services.

GCS_​HMAC_​AUTHENTICATION

Google Cloud Platform.

encoding_​versionenum

Specifies the version of the encryption algorithm, an integer from 1 to 5.

authentication_​method is SIGNATURE_​HEADER_​AUTHENTICATION
{"displayType":"enum","options":["1","2","3","4","5"],"tag":"select"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
use_​custom_​sign_​stringboolean

Specifies whether to customize your signed string.

authentication_​method is SIGNATURE_​HEADER_​AUTHENTICATION
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
custom_​sign_​stringstring array

Specifies the data to be encrypted as a series of enumerated variable names. See Built-in system variables for guidance on each.

authentication_​method is SIGNATURE_​HEADER_​AUTHENTICATION
AND use_​custom_​sign_​string is true
{"displayType":"string array","options":["AK_METHOD","AK_SCHEME","AK_HOSTHEADER","AK_DOMAIN","AK_URL","AK_PATH","AK_QUERY","AK_FILENAME","AK_EXTENSION","AK_CLIENT_REAL_IP"],"tag":"select"}
{"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"},{"attribute":"useCustomSignString","op":"eq","value":true}]}}
Supported values:
AK_CLIENT_REAL_IP
AK_DOMAIN
AK_EXTENSION
AK_FILENAME
AK_HOSTHEADER
AK_METHOD
AK_PATH
AK_QUERY
AK_SCHEME
AK_URL
secret_​keyobject array

Specifies the shared secret key.

authentication_​method is SIGNATURE_​HEADER_​AUTHENTICATION
{"displayType":"object array","tag":"input","todo":true}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
noncestring

Specifies the nonce.

authentication_​method is SIGNATURE_​HEADER_​AUTHENTICATION
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"SIGNATURE_HEADER_AUTHENTICATION"}}
mslkeystring

Specifies the access key provided by the hosting service.

authentication_​method is MSL_​AUTHENTICATION
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"MSL_AUTHENTICATION"}}
mslnamestring

Specifies the origin name provided by the hosting service.

authentication_​method is MSL_​AUTHENTICATION
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"MSL_AUTHENTICATION"}}
access_​key_​encrypted_​storageboolean

Enables secure use of access keys defined in Cloud Access Manager. Access keys store encrypted authentication details required to sign requests to cloud origins. If you disable this option, you'll need to store the authentication details unencrypted.

authentication_​method is either: AWS, GCS_​HMAC_​AUTHENTICATION
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"authenticationMethod","op":"in","value":["AWS","GCS_HMAC_AUTHENTICATION"]}}
gcs_​access_​key_​version_​guidstring

Identifies the unique gcs_​access_​key_​version_​guid access key created in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode.

authentication_​method is GCS_​HMAC_​AUTHENTICATION
AND access_​key_​encrypted_​storage is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"GCS_HMAC_AUTHENTICATION"},{"attribute":"accessKeyEncryptedStorage","op":"eq","value":true}]}}
gcs_​hmac_​key_​access_​idstring

Specifies the active access ID linked to your Google account.

authentication_​method is GCS_​HMAC_​AUTHENTICATION
AND access_​key_​encrypted_​storage is not true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"GCS_HMAC_AUTHENTICATION"},{"attribute":"accessKeyEncryptedStorage","op":"neq","value":true}]}}
gcs_​hmac_​key_​secretstring

Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.

authentication_​method is GCS_​HMAC_​AUTHENTICATION
AND access_​key_​encrypted_​storage is not true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"GCS_HMAC_AUTHENTICATION"},{"attribute":"accessKeyEncryptedStorage","op":"neq","value":true}]}}
aws_​access_​key_​version_​guidstring

Identifies the unique aws_​access_​key_​version_​guid access key created in Cloud Access Manager to sign your requests to AWS S3.

authentication_​method is AWS
AND access_​key_​encrypted_​storage is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"AWS"},{"attribute":"accessKeyEncryptedStorage","op":"eq","value":true}]}}
aws_​access_​key_​idstring

Specifies active access key ID linked to your AWS account.

authentication_​method is AWS
AND access_​key_​encrypted_​storage is not true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"AWS"},{"attribute":"accessKeyEncryptedStorage","op":"neq","value":true}]}}
aws_​secret_​access_​keystring

Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.

authentication_​method is AWS
AND access_​key_​encrypted_​storage is not true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"authenticationMethod","op":"eq","value":"AWS"},{"attribute":"accessKeyEncryptedStorage","op":"neq","value":true}]}}
aws_​regionstring

This specifies the AWS region code of the location where your bucket resides.

authentication_​method is AWS
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS"}}
aws_​hoststring

This specifies the AWS hostname, without http:// or https:// prefixes. If you leave this option empty, it inherits the hostname from the origin behavior.

authentication_​method is AWS
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS"}}
aws_​servicestring

This specifies the subdomain of your AWS service. It precedes amazonaws.​com or the region code in the AWS hostname. For example, s3.​amazonaws.​com.

authentication_​method is AWS
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"authenticationMethod","op":"eq","value":"AWS"}}