{ "openapi": "3.0.1", "externalDocs": { "description": "See documentation for Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference" }, "info": { "title": "Akamai: Cloud Wrapper Configuration API", "version": "v1", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "paths": { "/capacity": { "get": { "description": "View the capacities available for a given `contractId`.", "operationId": "get-capacity-inventory", "summary": "List capacity", "tags": [ "Capacity" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory" }, "responses": { "200": { "description": "The response provides the list of capacities.", "content": { "application/json": { "example": { "capacities": [ { "contractId": "K-0N7RAK7", "locationId": 4, "locationName": "India", "type": "MEDIA", "approvedCapacity": { "unit": "GB", "value": 7 }, "assignedCapacity": { "unit": "GB", "value": 0 }, "unassignedCapacity": { "unit": "GB", "value": 7 } }, { "contractId": "K-0N7RAK7", "locationId": 2, "locationName": "Australia", "type": "MEDIA", "approvedCapacity": { "unit": "GB", "value": 200 }, "assignedCapacity": { "unit": "GB", "value": 1 }, "unassignedCapacity": { "unit": "GB", "value": 199 } } ] }, "schema": { "additionalProperties": false, "description": "The list of location capacities.", "type": "object", "required": [ "capacities" ], "properties": { "capacities": { "description": "List of all location capacities.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "locationId", "locationName", "contractId", "approvedCapacity", "assignedCapacity", "unassignedCapacity", "type" ], "properties": { "approvedCapacity": { "additionalProperties": false, "description": "Capacity allocated for the location.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } }, "assignedCapacity": { "additionalProperties": false, "description": "Capacity already assigned to Cloud Wrapper configurations.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } }, "contractId": { "description": "Contract ID having Cloud Wrapper entitlement.", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "locationId": { "description": "Unique identifier of the configured location.", "format": "int64", "type": "integer" }, "locationName": { "description": "Name of the location.", "type": "string" }, "type": { "description": "The type of delivery property you've assigned this capacity to. `MEDIA` applies to live or video on demand content. `WEB_STANDARD_TLS` or `WEB_ENHANCED_TLS` applies to web content using Standard TLS security or Enhanced TLS security, respectively.", "type": "string", "enum": [ "MEDIA", "WEB_STANDARD_TLS", "WEB_ENHANCED_TLS" ] }, "unassignedCapacity": { "additionalProperties": false, "description": "The total amount of capacity you can assign to Cloud Wrapper configurations.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } } }, "x-akamai": { "file-path": "schemas/LocationCapacity.yaml" } } } }, "x-akamai": { "file-path": "schemas/Capacities.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "A list of contract IDs with Cloud Wrapper entitlement.", "example": "{{contractIds}}", "in": "query", "name": "contractIds", "required": false, "schema": { "type": "array", "items": { "example": "1-ABCDEF", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" } }, "x-akamai": { "file-path": "parameters/contractIds-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/configurations": { "post": { "description": "Create a Cloud Wrapper configuration. You first need to work with your account team to include Cloud Wrapper locations and capacity on your contract. Verify your capacity by viewing your [capacity inventory](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory).", "operationId": "post-configuration", "summary": "Create a configuration", "tags": [ "Configurations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "activate": false, "capacityAlertsThreshold": 50, "comments": "Real traffic", "configName": "example-prod-live", "contractId": "C-0N7RAC7", "retainIdleObjects": false, "notificationEmails": [], "propertyIds": [ "123456" ], "multiCdnSettings": { "enableSoftAlerts": true, "bocc": { "enabled": false }, "dataStreams": { "enabled": false }, "cdns": [ { "cdnCode": "dn002", "enabled": true, "httpsOnly": true, "ipAclCidrs": [ "2001:db8:d115:68fb:cdc1:4619:e9a1:2a3b/32" ], "cdnAuthKeys": [ { "authKeyName": "Customer traffic key", "expiryDate": "2023-08-08T17:29:21.000Z", "headerName": "CDN-Origin-Auth" } ] } ], "origins": [ { "hostname": "example.com", "originId": "origin770", "propertyId": 123456 } ] }, "locations": [ { "comments": "Real traffic", "trafficTypeId": 4, "capacity": { "unit": "GB", "value": 500 } } ] }, "schema": { "additionalProperties": false, "description": "Creates a Cloud Wrapper configuration.", "type": "object", "required": [ "comments", "contractId", "locations", "configName", "propertyIds" ], "properties": { "capacityAlertsThreshold": { "description": "Capacity Alerts enablement information for the configuration.", "example": "{{capacityAlertsThreshold}}", "format": "int64", "maximum": 100, "minimum": 50, "nullable": true, "type": "integer" }, "comments": { "description": "Additional information you provide to differentiate or track changes of the configuration.", "example": "{{comments}}", "maxLength": 255, "minLength": 1, "type": "string" }, "configName": { "description": "The name of the configuration (property) you've set up to deliver your content. This is the `propertyName` you set when you [create](https://techdocs.akamai.com/property-mgr/reference/post-properties) the property.", "example": "{{configName}}", "maxLength": 20, "minLength": 4, "pattern": "[A-Za-z0-9-]*$", "type": "string" }, "contractId": { "description": "Contract ID having Cloud Wrapper entitlement.", "example": "{{contractId}}", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "locations": { "description": "List of locations to use with the configuration. Locations need to have a pre-approved capacity approval for the selected contract.", "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Location configuration that describes property and traffic type.", "type": "object", "required": [ "comments", "capacity", "trafficTypeId" ], "properties": { "capacity": { "additionalProperties": false, "description": "The capacity assigned to this configuration's location. [List capacity](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory) to view the `approvedCapacity` and `assignedCapacity` capacities.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } }, "comments": { "description": "Additional comments provided by user.", "maxLength": 255, "minLength": 1, "type": "string" }, "trafficTypeId": { "description": "Unique identifier for the location and traffic type combination. You can [list locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) to see your available combinations.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ConfigLocation.yaml" } } }, "multiCdnSettings": { "additionalProperties": false, "description": "Specify details about the Multi CDN settings.", "nullable": true, "type": "object", "required": [ "bocc", "cdns", "dataStreams", "origins" ], "properties": { "advancedSettings": { "additionalProperties": false, "description": "Specifies advanced settings. This is only available to Akamai Global Services Support.", "type": "object", "required": [ "denyResponseCode" ], "properties": { "advancedXmlPost": { "description": "Text appended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "advancedXmlPre": { "description": "Text prepended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "amdLiveSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver live streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentDurationDashCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationHLSCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationSmoothCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDLive.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdLiveSetting.yaml" } }, "amdVodSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver on-demand streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDVod.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdVodSetting.yaml" } }, "baseDirectory": { "additionalProperties": false, "description": "Specifies the [base path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of content on your origin server.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the base path of content on your origin server. The value needs to begin and end with a slash (/) character.", "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/BaseDirectory.yaml" } }, "cacheKeyQueryParams": { "additionalProperties": false, "description": "Consolidates cached objects based on specified sets of [query parameters](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params).", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "Configure how sets of query string parameters translate to cache keys. See [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params) for details on applicable values.", "type": "string", "enum": [ "IGNORE", "IGNORE_ALL", "INCLUDE", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ] }, "exactMatch": { "description": "When enabled, `parameters` needs to match exactly. Keep disabled to match string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "parameters": { "description": "Specifies the set of parameter field names to include in or exclude from the cache key. By default, these match the field names as string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "minItems": 1, "nullable": true, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/CacheKeyQueryParams.yaml" } }, "denyResponseCode": { "description": "The code of a deny response, either `403` or `429`.", "type": "integer", "enum": [ 403, 429 ] }, "downloadDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Download Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsDD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "objectSize": { "description": "Optimize based on the size of the object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsDD.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/DownloadDeliverySetting.yaml" } }, "objectDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Object Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/ObjectDeliverySetting.yaml" } }, "rewriteUrl": { "additionalProperties": false, "description": "Modifies the [path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of incoming requests to forward to your origin server.", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "The action to perform on the path. Either `REPLACE`, `REMOVE`, `PREPEND`, `REWRITE` or `REGEX_REPLACE`.", "type": "string", "enum": [ "REPLACE", "REMOVE", "PREPEND", "REWRITE", "REGEX_REPLACE" ] }, "keepQueryString": { "description": "Enable this to keep the original path's query parameters. You can't enable this if you've set this behavior to `REWRITE`.", "nullable": true, "type": "boolean" }, "match": { "description": "When the behavior is `REMOVE` or `REPLACE`, this specifies the part of the incoming path you'd like to remove or modify.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "matchMultiple": { "description": "When enabled, replaces all potential matches rather than only the first. For this behavior it's either: `REMOVE`, `REPLACE`, or `REGEX_REPLACE`.", "nullable": true, "type": "boolean" }, "matchRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this specifies the Perl-compatible regular expression to replace with `targetRegex`.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPath": { "description": "When the behavior is set to `REPLACE`, this path replaces whatever the match field matches in the incoming request's path.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPathPrepend": { "description": "When the behavior is set to `PREPEND`, this specifies a path to prepend to the incoming request's URL.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this replaces whatever the `matchRegex` field matches.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetUrl": { "description": "When the behavior is set to `REWRITE`, this specifies the full path to request from the origin.", "nullable": true, "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/RewriteUrl.yaml" } } }, "x-akamai": { "file-path": "schemas/AdvancedSettings.yaml", "status": "INTERNAL" } }, "bocc": { "additionalProperties": false, "description": "Specify diagnostic data beacons details. This enables real-time beaconing for [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "object", "required": [ "samplingFrequency", "requestType", "forwardType", "conditionalSamplingFrequency", "enabled" ], "properties": { "conditionalSamplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] }, "enabled": { "description": "Enable diagnostic data beacons for consumption by the [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "boolean" }, "forwardType": { "description": "Select whether to beacon diagnostics data for internal `ORIGIN_ONLY`, `MIDGRESS_ONLY`, or both `ORIGIN_AND_MIDGRESS` forwards.", "type": "string", "enum": [ "ORIGIN_ONLY", "MIDGRESS_ONLY", "ORIGIN_AND_MIDGRESS" ] }, "requestType": { "description": "Select whether to beacon diagnostics data for `EDGE_ONLY` or `EDGE_AND_MIDGRESS` requests.", "type": "string", "enum": [ "EDGE_ONLY", "EDGE_AND_MIDGRESS" ] }, "samplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] } }, "x-akamai": { "file-path": "schemas/Bocc.yaml", "status": "INTERNAL" } }, "cdns": { "description": "List of CDN added for the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "cdnCode", "enabled" ], "properties": { "cdnAuthKeys": { "description": "List of auth keys configured for the CDN.", "minItems": 0, "type": "array", "items": { "oneOf": [ { "additionalProperties": false, "title": "Use an existing auth key", "type": "object", "required": [ "authKeyName" ], "properties": { "authKeyName": { "description": "Name of the auth key.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/AuthKey.yaml" } }, { "additionalProperties": false, "title": "Create new auth keys", "type": "object", "required": [ "authKeyName", "expiryDate", "headerName" ], "properties": { "authKeyName": { "description": "Name of the new auth key.", "type": "string", "writeOnly": true }, "expiryDate": { "description": "ISO 8601 expiration date of the key.", "format": "date-time", "type": "string" }, "headerName": { "description": "The header name you want to use for the auth key. If you leave this out, the API uses the name of the third-party CDN you specified via the `cdnCode` in your Cloud Wrapper [configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration).", "type": "string", "writeOnly": true }, "secret": { "description": "A unique, 24 character hexadecimal string to use with CDN auth keys.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/NewAuthKey.yaml" } } ] } }, "cdnCode": { "description": "Unique identifier for the CDN. [List CDN providers](https://techdocs.akamai.com/cloud-wrapper/reference/get-providers) for a list of available CDNs.", "type": "string" }, "enabled": { "description": "Enable CDN.", "type": "boolean" }, "httpsOnly": { "description": "Specify whether CDN communication is HTTPS only.", "type": "boolean" }, "ipAclCidrs": { "description": "Configure an access control list using IP addresses in CIDR notation. You get a denial of service error if your CDN makes requests from IPs that aren't part of the list configured here. You need to maintain the IP/CIDR list in this configuration to ensure it's up-to-date with your CDN's list. Cloud Wrapper can receive traffic from your downstream CDN using both IPv4 and IPv6 addresses. Include both IPv4 and IPv6 CDN addresses in your ACLs. View the [FAQ](https://techdocs.akamai.com/cloud-wrapper/docs/faq-and-considerations) for information about setting up auth alerts.", "minItems": 0, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/ConfigCdn.yaml" } } }, "dataStreams": { "additionalProperties": false, "description": "Specifies data streams details.", "type": "object", "required": [ "dataStreamIds", "enabled", "samplingRate" ], "properties": { "dataStreamIds": { "description": "The unique identifiers Akamai assigns to the DataStreams. Use the [DataStream API](https://techdocs.akamai.com/datastream2/reference/api) to view stream configurations.", "minItems": 1, "type": "array", "items": { "format": "int64", "maximum": 10000000000, "minimum": 1, "type": "integer" } }, "enabled": { "description": "Enables DataStream reporting.", "type": "boolean" }, "samplingRate": { "description": "Specifies the percentage of log data you want to collect for this configuration.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/DataStreams.yaml" } }, "enableSoftAlerts": { "default": false, "description": "Option to opt out of alerts based on soft limits of bandwidth usage.", "type": "boolean" }, "origins": { "description": "List of origins corresponding to the properties selected in the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hostname", "originId", "propertyId" ], "properties": { "hostname": { "description": "The origin hostname you've set for your origin server in your Property Manager delivery configuration.", "type": "string" }, "originId": { "description": "The origin identifier that's used to generate Multi CDN hostnames.", "maxLength": 10, "minLength": 3, "type": "string" }, "propertyId": { "description": "The [Property ID](https://techdocs.akamai.com/cloud-wrapper/reference/get-properties) of the property the origin belongs to.", "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ConfigOrigin.yaml" } } } }, "x-akamai": { "file-path": "schemas/ConfigMultiCdnSettings.yaml" } }, "notificationEmails": { "description": "Email addresses to use for notifications.", "minItems": 0, "type": "array", "items": { "format": "email", "type": "string" } }, "propertyIds": { "description": "A list of identifiers that represents the [properties](https://techdocs.akamai.com/cloud-wrapper/reference/concepts) eligible to add Cloud Wrapper. To see property specifics, run the [list properties](https://techdocs.akamai.com/cloud-wrapper/reference/get-properties) operation.", "minItems": 1, "type": "array", "items": { "maximum": 1000000000, "minimum": 1, "type": "string" } }, "retainIdleObjects": { "default": false, "description": "By default, idle objects are kept in your footprint for 30 days. Set this to `true` to retain them beyond this 30 day limit. This only applies to [locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) you've configured with a redundant content `type` like `LIVE_VOD` or `WEB_STANDARD_TLS`.", "example": "{{retainIdleObjects}}", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/CreateConfiguration.yaml" } } } } }, "responses": { "201": { "description": "The response provides the new configuration.", "content": { "application/json": { "example": { "capacityAlertsThreshold": 50, "comments": "Real traffic", "configName": "example-prod-live", "contractId": "K-0N7RAK7", "id": 2667, "lastActivatedBy": null, "lastActivatedDate": null, "lastUpdatedBy": "afero", "lastUpdatedDate": "2022-06-10T13:21:14.488Z", "retainIdleObjects": false, "status": "IN_PROGRESS", "notificationEmails": [ "johndoe@example.com" ], "propertyIds": [ "123456" ], "multiCdnSettings": { "arlId": null, "enableSoftAlerts": true, "bocc": { "enabled": false }, "dataStreams": { "enabled": false }, "cdns": [ { "cdnCode": "dn002", "enabled": true, "httpsOnly": true, "cdnAuthKeys": [], "ipAclCidrs": [ "2001:db8:fa81:12b9:8553:df2d:a30e:d0c9/32" ] } ], "origins": [ { "hostname": "example.com", "originId": "origin770", "propertyId": 123456 } ] }, "locations": [ { "comments": "Real traffic", "mapName": "cw-s-usw-live", "trafficTypeId": 4, "capacity": { "unit": "GB", "value": 500 } } ] }, "schema": { "additionalProperties": false, "description": "Encompasses the Cloud Wrapper configuration.", "type": "object", "required": [ "comments", "contractId", "locations", "configName", "propertyIds" ], "properties": { "capacityAlertsThreshold": { "description": "Represents the threshold for sending alerts.", "format": "int64", "maximum": 100, "minimum": 50, "nullable": true, "type": "integer" }, "comments": { "description": "Additional information provided by user which can help to differentiate or track changes of the configuration.", "maxLength": 255, "minLength": 1, "type": "string" }, "configId": { "description": "The unique ID that Akamai generated for your Cloud Wrapper configuration.", "type": "integer" }, "configName": { "description": "The name of the configuration (property) you've set up to deliver your content. This is the `propertyName` you set when you [create](https://techdocs.akamai.com/property-mgr/reference/post-properties) the property.", "type": "string" }, "contractId": { "description": "Contract ID with Cloud Wrapper entitlement.", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "lastActivatedBy": { "description": "User to last activate the configuration.", "type": "string" }, "lastActivatedDate": { "description": "The last time you successfully activated the configuration, in ISO 8601 format.", "format": "date-time", "type": "string" }, "lastUpdatedBy": { "description": "User to last modify the configuration.", "type": "string" }, "lastUpdatedDate": { "description": "The last time you edited the configuration, in ISO 8601 format.", "format": "date-time", "type": "string" }, "locations": { "description": "The [list of locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) you've applied in the configuration. Any locations you include need to have Cloud Wrapper capacity pre-approved on the contract you've selected.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Location configuration that describes property and traffic type.", "type": "object", "required": [ "comments", "capacity", "trafficTypeId", "mapName" ], "properties": { "capacity": { "additionalProperties": false, "description": "The capacity assigned to this configuration's location. [List capacity](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory) to view the `approvedCapacity` and `assignedCapacity` values.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } }, "comments": { "description": "Additional comments provided by user.", "maxLength": 255, "minLength": 1, "type": "string" }, "mapName": { "description": "Name of the map used for the Cloud Wrapper geographic region.", "type": "string" }, "trafficTypeId": { "description": "Unique identifier for the location and traffic type combination. You can run the [list locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) operation to see your available combinations.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ResponseConfigLocation.yaml" } } }, "multiCdnSettings": { "additionalProperties": false, "description": "Specify details about the Multi CDN settings.", "nullable": true, "type": "object", "required": [ "bocc", "cdns", "dataStreams", "origins", "arlId" ], "properties": { "advancedSettings": { "additionalProperties": false, "description": "Describes advanced settings. Note that this field is available only for internal users.", "type": "object", "required": [ "denyResponseCode" ], "properties": { "advancedXmlPost": { "description": "Text appended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "advancedXmlPre": { "description": "Text prepended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "amdLiveSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver live streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentDurationDashCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationHLSCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationSmoothCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDLive.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdLiveSetting.yaml" } }, "amdVodSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver on-demand streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDVod.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdVodSetting.yaml" } }, "baseDirectory": { "additionalProperties": false, "description": "Specifies the [base path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of content on your origin server.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the base path of content on your origin server. The value needs to begin and end with a slash (/) character.", "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/BaseDirectory.yaml" } }, "cacheKeyQueryParams": { "additionalProperties": false, "description": "Consolidates cached objects based on specified sets of [query parameters](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params).", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "Configure how sets of query string parameters translate to cache keys. See [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params) for details on applicable values.", "type": "string", "enum": [ "IGNORE", "IGNORE_ALL", "INCLUDE", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ] }, "exactMatch": { "description": "When enabled, `parameters` needs to match exactly. Keep disabled to match string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "parameters": { "description": "Specifies the set of parameter field names to include in or exclude from the cache key. By default, these match the field names as string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "minItems": 1, "nullable": true, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/CacheKeyQueryParams.yaml" } }, "denyResponseCode": { "description": "The code of a deny response, either `403` or `429`.", "type": "integer", "enum": [ 403, 429 ] }, "downloadDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Download Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsDD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "objectSize": { "description": "Optimize based on the size of the object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsDD.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/DownloadDeliverySetting.yaml" } }, "objectDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Object Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/ObjectDeliverySetting.yaml" } }, "rewriteUrl": { "additionalProperties": false, "description": "Modifies the [path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of incoming requests to forward to your origin server.", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "The action to perform on the path. Either `REPLACE`, `REMOVE`, `PREPEND`, `REWRITE` or `REGEX_REPLACE`.", "type": "string", "enum": [ "REPLACE", "REMOVE", "PREPEND", "REWRITE", "REGEX_REPLACE" ] }, "keepQueryString": { "description": "Enable this to keep the original path's query parameters. You can't enable this if you've set this behavior to `REWRITE`.", "nullable": true, "type": "boolean" }, "match": { "description": "When the behavior is `REMOVE` or `REPLACE`, this specifies the part of the incoming path you'd like to remove or modify.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "matchMultiple": { "description": "When enabled, replaces all potential matches rather than only the first. For this behavior it's either: `REMOVE`, `REPLACE`, or `REGEX_REPLACE`.", "nullable": true, "type": "boolean" }, "matchRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this specifies the Perl-compatible regular expression to replace with `targetRegex`.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPath": { "description": "When the behavior is set to `REPLACE`, this path replaces whatever the match field matches in the incoming request's path.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPathPrepend": { "description": "When the behavior is set to `PREPEND`, this specifies a path to prepend to the incoming request's URL.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this replaces whatever the `matchRegex` field matches.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetUrl": { "description": "When the behavior is set to `REWRITE`, this specifies the full path to request from the origin.", "nullable": true, "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/RewriteUrl.yaml" } } }, "x-akamai": { "file-path": "schemas/AdvancedSettings.yaml", "status": "INTERNAL" } }, "arlId": { "description": "Unique identifier for the Akamai Resource Locator.", "nullable": true, "type": "integer" }, "bocc": { "additionalProperties": false, "description": "Specify diagnostic data beacons details. It enables real time beaconing for [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "object", "required": [ "samplingFrequency", "requestType", "forwardType", "conditionalSamplingFrequency", "enabled" ], "properties": { "conditionalSamplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] }, "enabled": { "description": "Enable diagnostic data beacons for consumption by the [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "boolean" }, "forwardType": { "description": "Select whether to beacon diagnostics data for internal `ORIGIN_ONLY`, `MIDGRESS_ONLY`, or both `ORIGIN_AND_MIDGRESS` forwards.", "type": "string", "enum": [ "ORIGIN_ONLY", "MIDGRESS_ONLY", "ORIGIN_AND_MIDGRESS" ] }, "requestType": { "description": "Select whether to beacon diagnostics data for `EDGE_ONLY` or `EDGE_AND_MIDGRESS` requests.", "type": "string", "enum": [ "EDGE_ONLY", "EDGE_AND_MIDGRESS" ] }, "samplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] } }, "x-akamai": { "file-path": "schemas/Bocc.yaml", "status": "INTERNAL" } }, "cdns": { "description": "List of CDN added for the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "cdnCode", "enabled" ], "properties": { "cdnAuthKeys": { "description": "List of auth keys configured for the CDN.", "minItems": 0, "type": "array", "items": { "oneOf": [ { "additionalProperties": false, "title": "Use an existing auth key", "type": "object", "required": [ "authKeyName" ], "properties": { "authKeyName": { "description": "Name of the auth key.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/AuthKey.yaml" } }, { "additionalProperties": false, "title": "Create new auth keys", "type": "object", "required": [ "authKeyName", "expiryDate", "headerName" ], "properties": { "authKeyName": { "description": "Name of the new auth key.", "type": "string", "writeOnly": true }, "expiryDate": { "description": "ISO 8601 expiration date of the key.", "format": "date-time", "type": "string" }, "headerName": { "description": "The header name you want to use for the auth key. If you leave this out, the API uses the name of the third-party CDN you specified via the `cdnCode` in your Cloud Wrapper [configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration).", "type": "string", "writeOnly": true }, "secret": { "description": "A unique, 24 character hexadecimal string to use with CDN auth keys.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/NewAuthKey.yaml" } } ] } }, "cdnCode": { "description": "Unique identifier for the CDN. [List CDN providers](https://techdocs.akamai.com/cloud-wrapper/reference/get-providers) for a list of available CDNs.", "type": "string" }, "enabled": { "description": "Enable CDN.", "type": "boolean" }, "httpsOnly": { "description": "Specify whether CDN communication is HTTPS only.", "type": "boolean" }, "ipAclCidrs": { "description": "Configure an access control list using IP addresses in CIDR notation. You get a denial of service error if your CDN makes requests from IPs that aren't part of the list configured here. You need to maintain the IP/CIDR list in this configuration to ensure it's up-to-date with your CDN's list. Cloud Wrapper can receive traffic from your downstream CDN using both IPv4 and IPv6 addresses. Include both IPv4 and IPv6 CDN addresses in your ACLs. View the [FAQ](https://techdocs.akamai.com/cloud-wrapper/docs/faq-and-considerations) for information about setting up auth alerts.", "minItems": 0, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/ConfigCdn.yaml" } } }, "dataStreams": { "additionalProperties": false, "description": "Specifies data streams details.", "type": "object", "required": [ "dataStreamIds", "enabled", "samplingRate" ], "properties": { "dataStreamIds": { "description": "The unique identifiers Akamai assigns to the DataStreams. Use the [DataStream API](https://techdocs.akamai.com/datastream2/reference/api) to view stream configurations.", "minItems": 1, "type": "array", "items": { "format": "int64", "maximum": 10000000000, "minimum": 1, "type": "integer" } }, "enabled": { "description": "Enables DataStream reporting.", "type": "boolean" }, "samplingRate": { "description": "Specifies the percentage of log data you want to collect for this configuration.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/DataStreams.yaml" } }, "enableSoftAlerts": { "default": false, "description": "Option to opt out of alerts based on soft limits of bandwidth usage.", "type": "boolean" }, "origins": { "description": "List of origins corresponding to the properties selected in the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hostname", "originId", "propertyId" ], "properties": { "hostname": { "description": "The origin hostname you've set for your origin server in your Property Manager delivery configuration.", "type": "string" }, "originId": { "description": "The origin identifier that's used to generate Multi CDN hostnames.", "maxLength": 10, "minLength": 3, "type": "string" }, "propertyId": { "description": "The [Property ID](https://techdocs.akamai.com/cloud-wrapper/reference/get-properties) of the property the origin belongs to.", "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ConfigOrigin.yaml" } } } }, "x-akamai": { "file-path": "schemas/ConfigMultiCdnSettingsResponse.yaml" } }, "notificationEmails": { "description": "Email addresses to receive notifications.", "minItems": 0, "type": "array", "items": { "format": "email", "type": "string" } }, "propertyIds": { "description": "List of [properties](https://techdocs.akamai.com/cloud-wrapper/reference/concepts) belonging to eligible delivery products.", "minItems": 1, "type": "array", "items": { "maxLength": 1000000000, "minLength": 1, "type": "string" } }, "retainIdleObjects": { "default": false, "description": "Retain idle objects beyond their max idle lifetime.", "type": "boolean" }, "status": { "description": "Current provisioning state of the configuration, either `SAVED`, `IN_PROGRESS`, `ACTIVE`, `DELETE_IN_PROGRESS`, or `FAILED`.", "type": "string", "enum": [ "SAVED", "IN_PROGRESS", "ACTIVE", "DELETE_IN_PROGRESS", "FAILED" ] } }, "x-akamai": { "file-path": "schemas/Configuration.yaml" } } } }, "headers": { "Location": { "schema": { "type": "string" } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "description": "[Unsupported media type](https://techdocs.akamai.com/cloud-wrapper/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "Specify if you want to activate the modified configuration, `false` by default. Otherwise, you can run the [Activate a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration-activations) operation separately.", "example": "{{activate}}", "in": "query", "name": "activate", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/activate-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "List all of the Cloud Wrapper configurations on your contract.", "operationId": "get-configurations", "summary": "List configurations", "tags": [ "Configurations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-configurations" }, "responses": { "200": { "description": "The response lists your configurations.", "content": { "application/json": { "example": { "configurations": [ { "capacityAlertsThreshold": null, "comments": "Use this config for testing before going live.", "configName": "config-for-testing", "contractId": "K-0N7RAK71", "id": 2610, "lastActivatedDate": "2022-04-28T07:15:45.000Z", "lastUpdatedBy": "adevi", "lastUpdatedDate": "2022-04-28T07:15:45.000Z", "multiCdnSettings": null, "retainIdleObjects": false, "status": "ACTIVE", "notificationEmails": [ "johndoe@example.com" ], "propertyIds": [ "123456" ], "locations": [ { "comments": "Only for validation", "mapName": "cw-s-use", "trafficTypeId": 2, "capacity": { "unit": "GB", "value": 1 } } ] }, { "capacityAlertsThreshold": null, "comments": "Real customer traffic", "configName": "production-config", "contractId": "K-0N7RAK7", "id": 2611, "lastActivatedBy": "jperez", "lastActivatedDate": "2022-05-24T06:12:48.000Z", "lastUpdatedBy": "hgildong", "lastUpdatedDate": "2022-05-24T06:12:48.000Z", "multiCdnSettings": null, "retainIdleObjects": false, "status": "ACTIVE", "notificationEmails": [], "propertyIds": [ "123456" ], "locations": [ { "comments": "Real traffic", "mapName": "cw-s-use-live", "trafficTypeId": 1, "capacity": { "unit": "GB", "value": 500 } } ] } ] }, "schema": { "additionalProperties": false, "description": "List of Cloud Wrapper configurations.", "type": "object", "required": [ "configurations" ], "properties": { "configurations": { "description": "List of Cloud Wrapper configurations.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "description": "Encompasses the Cloud Wrapper configuration.", "type": "object", "required": [ "comments", "contractId", "locations", "configName", "propertyIds" ], "properties": { "capacityAlertsThreshold": { "description": "Represents the threshold for sending alerts.", "format": "int64", "maximum": 100, "minimum": 50, "nullable": true, "type": "integer" }, "comments": { "description": "Additional information provided by user which can help to differentiate or track changes of the configuration.", "maxLength": 255, "minLength": 1, "type": "string" }, "configId": { "description": "The unique ID that Akamai generated for your Cloud Wrapper configuration.", "type": "integer" }, "configName": { "description": "The name of the configuration (property) you've set up to deliver your content. This is the `propertyName` you set when you [create](https://techdocs.akamai.com/property-mgr/reference/post-properties) the property.", "type": "string" }, "contractId": { "description": "Contract ID with Cloud Wrapper entitlement.", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "lastActivatedBy": { "description": "User to last activate the configuration.", "type": "string" }, "lastActivatedDate": { "description": "The last time you successfully activated the configuration, in ISO 8601 format.", "format": "date-time", "type": "string" }, "lastUpdatedBy": { "description": "User to last modify the configuration.", "type": "string" }, "lastUpdatedDate": { "description": "The last time you edited the configuration, in ISO 8601 format.", "format": "date-time", "type": "string" }, "locations": { "description": "The [list of locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) you've applied in the configuration. Any locations you include need to have Cloud Wrapper capacity pre-approved on the contract you've selected.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Location configuration that describes property and traffic type.", "type": "object", "required": [ "comments", "capacity", "trafficTypeId", "mapName" ], "properties": { "capacity": { "additionalProperties": false, "description": "The capacity assigned to this configuration's location. [List capacity](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory) to view the `approvedCapacity` and `assignedCapacity` values.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } }, "comments": { "description": "Additional comments provided by user.", "maxLength": 255, "minLength": 1, "type": "string" }, "mapName": { "description": "Name of the map used for the Cloud Wrapper geographic region.", "type": "string" }, "trafficTypeId": { "description": "Unique identifier for the location and traffic type combination. You can run the [list locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) operation to see your available combinations.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ResponseConfigLocation.yaml" } } }, "multiCdnSettings": { "additionalProperties": false, "description": "Specify details about the Multi CDN settings.", "nullable": true, "type": "object", "required": [ "bocc", "cdns", "dataStreams", "origins", "arlId" ], "properties": { "advancedSettings": { "additionalProperties": false, "description": "Describes advanced settings. Note that this field is available only for internal users.", "type": "object", "required": [ "denyResponseCode" ], "properties": { "advancedXmlPost": { "description": "Text appended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "advancedXmlPre": { "description": "Text prepended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "amdLiveSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver live streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentDurationDashCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationHLSCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationSmoothCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDLive.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdLiveSetting.yaml" } }, "amdVodSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver on-demand streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDVod.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdVodSetting.yaml" } }, "baseDirectory": { "additionalProperties": false, "description": "Specifies the [base path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of content on your origin server.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the base path of content on your origin server. The value needs to begin and end with a slash (/) character.", "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/BaseDirectory.yaml" } }, "cacheKeyQueryParams": { "additionalProperties": false, "description": "Consolidates cached objects based on specified sets of [query parameters](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params).", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "Configure how sets of query string parameters translate to cache keys. See [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params) for details on applicable values.", "type": "string", "enum": [ "IGNORE", "IGNORE_ALL", "INCLUDE", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ] }, "exactMatch": { "description": "When enabled, `parameters` needs to match exactly. Keep disabled to match string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "parameters": { "description": "Specifies the set of parameter field names to include in or exclude from the cache key. By default, these match the field names as string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "minItems": 1, "nullable": true, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/CacheKeyQueryParams.yaml" } }, "denyResponseCode": { "description": "The code of a deny response, either `403` or `429`.", "type": "integer", "enum": [ 403, 429 ] }, "downloadDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Download Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsDD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "objectSize": { "description": "Optimize based on the size of the object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsDD.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/DownloadDeliverySetting.yaml" } }, "objectDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Object Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/ObjectDeliverySetting.yaml" } }, "rewriteUrl": { "additionalProperties": false, "description": "Modifies the [path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of incoming requests to forward to your origin server.", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "The action to perform on the path. Either `REPLACE`, `REMOVE`, `PREPEND`, `REWRITE` or `REGEX_REPLACE`.", "type": "string", "enum": [ "REPLACE", "REMOVE", "PREPEND", "REWRITE", "REGEX_REPLACE" ] }, "keepQueryString": { "description": "Enable this to keep the original path's query parameters. You can't enable this if you've set this behavior to `REWRITE`.", "nullable": true, "type": "boolean" }, "match": { "description": "When the behavior is `REMOVE` or `REPLACE`, this specifies the part of the incoming path you'd like to remove or modify.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "matchMultiple": { "description": "When enabled, replaces all potential matches rather than only the first. For this behavior it's either: `REMOVE`, `REPLACE`, or `REGEX_REPLACE`.", "nullable": true, "type": "boolean" }, "matchRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this specifies the Perl-compatible regular expression to replace with `targetRegex`.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPath": { "description": "When the behavior is set to `REPLACE`, this path replaces whatever the match field matches in the incoming request's path.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPathPrepend": { "description": "When the behavior is set to `PREPEND`, this specifies a path to prepend to the incoming request's URL.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this replaces whatever the `matchRegex` field matches.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetUrl": { "description": "When the behavior is set to `REWRITE`, this specifies the full path to request from the origin.", "nullable": true, "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/RewriteUrl.yaml" } } }, "x-akamai": { "file-path": "schemas/AdvancedSettings.yaml", "status": "INTERNAL" } }, "arlId": { "description": "Unique identifier for the Akamai Resource Locator.", "nullable": true, "type": "integer" }, "bocc": { "additionalProperties": false, "description": "Specify diagnostic data beacons details. It enables real time beaconing for [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "object", "required": [ "samplingFrequency", "requestType", "forwardType", "conditionalSamplingFrequency", "enabled" ], "properties": { "conditionalSamplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] }, "enabled": { "description": "Enable diagnostic data beacons for consumption by the [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "boolean" }, "forwardType": { "description": "Select whether to beacon diagnostics data for internal `ORIGIN_ONLY`, `MIDGRESS_ONLY`, or both `ORIGIN_AND_MIDGRESS` forwards.", "type": "string", "enum": [ "ORIGIN_ONLY", "MIDGRESS_ONLY", "ORIGIN_AND_MIDGRESS" ] }, "requestType": { "description": "Select whether to beacon diagnostics data for `EDGE_ONLY` or `EDGE_AND_MIDGRESS` requests.", "type": "string", "enum": [ "EDGE_ONLY", "EDGE_AND_MIDGRESS" ] }, "samplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] } }, "x-akamai": { "file-path": "schemas/Bocc.yaml", "status": "INTERNAL" } }, "cdns": { "description": "List of CDN added for the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "cdnCode", "enabled" ], "properties": { "cdnAuthKeys": { "description": "List of auth keys configured for the CDN.", "minItems": 0, "type": "array", "items": { "oneOf": [ { "additionalProperties": false, "title": "Use an existing auth key", "type": "object", "required": [ "authKeyName" ], "properties": { "authKeyName": { "description": "Name of the auth key.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/AuthKey.yaml" } }, { "additionalProperties": false, "title": "Create new auth keys", "type": "object", "required": [ "authKeyName", "expiryDate", "headerName" ], "properties": { "authKeyName": { "description": "Name of the new auth key.", "type": "string", "writeOnly": true }, "expiryDate": { "description": "ISO 8601 expiration date of the key.", "format": "date-time", "type": "string" }, "headerName": { "description": "The header name you want to use for the auth key. If you leave this out, the API uses the name of the third-party CDN you specified via the `cdnCode` in your Cloud Wrapper [configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration).", "type": "string", "writeOnly": true }, "secret": { "description": "A unique, 24 character hexadecimal string to use with CDN auth keys.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/NewAuthKey.yaml" } } ] } }, "cdnCode": { "description": "Unique identifier for the CDN. [List CDN providers](https://techdocs.akamai.com/cloud-wrapper/reference/get-providers) for a list of available CDNs.", "type": "string" }, "enabled": { "description": "Enable CDN.", "type": "boolean" }, "httpsOnly": { "description": "Specify whether CDN communication is HTTPS only.", "type": "boolean" }, "ipAclCidrs": { "description": "Configure an access control list using IP addresses in CIDR notation. You get a denial of service error if your CDN makes requests from IPs that aren't part of the list configured here. You need to maintain the IP/CIDR list in this configuration to ensure it's up-to-date with your CDN's list. Cloud Wrapper can receive traffic from your downstream CDN using both IPv4 and IPv6 addresses. Include both IPv4 and IPv6 CDN addresses in your ACLs. View the [FAQ](https://techdocs.akamai.com/cloud-wrapper/docs/faq-and-considerations) for information about setting up auth alerts.", "minItems": 0, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/ConfigCdn.yaml" } } }, "dataStreams": { "additionalProperties": false, "description": "Specifies data streams details.", "type": "object", "required": [ "dataStreamIds", "enabled", "samplingRate" ], "properties": { "dataStreamIds": { "description": "The unique identifiers Akamai assigns to the DataStreams. Use the [DataStream API](https://techdocs.akamai.com/datastream2/reference/api) to view stream configurations.", "minItems": 1, "type": "array", "items": { "format": "int64", "maximum": 10000000000, "minimum": 1, "type": "integer" } }, "enabled": { "description": "Enables DataStream reporting.", "type": "boolean" }, "samplingRate": { "description": "Specifies the percentage of log data you want to collect for this configuration.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/DataStreams.yaml" } }, "enableSoftAlerts": { "default": false, "description": "Option to opt out of alerts based on soft limits of bandwidth usage.", "type": "boolean" }, "origins": { "description": "List of origins corresponding to the properties selected in the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hostname", "originId", "propertyId" ], "properties": { "hostname": { "description": "The origin hostname you've set for your origin server in your Property Manager delivery configuration.", "type": "string" }, "originId": { "description": "The origin identifier that's used to generate Multi CDN hostnames.", "maxLength": 10, "minLength": 3, "type": "string" }, "propertyId": { "description": "The [Property ID](https://techdocs.akamai.com/cloud-wrapper/reference/get-properties) of the property the origin belongs to.", "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ConfigOrigin.yaml" } } } }, "x-akamai": { "file-path": "schemas/ConfigMultiCdnSettingsResponse.yaml" } }, "notificationEmails": { "description": "Email addresses to receive notifications.", "minItems": 0, "type": "array", "items": { "format": "email", "type": "string" } }, "propertyIds": { "description": "List of [properties](https://techdocs.akamai.com/cloud-wrapper/reference/concepts) belonging to eligible delivery products.", "minItems": 1, "type": "array", "items": { "maxLength": 1000000000, "minLength": 1, "type": "string" } }, "retainIdleObjects": { "default": false, "description": "Retain idle objects beyond their max idle lifetime.", "type": "boolean" }, "status": { "description": "Current provisioning state of the configuration, either `SAVED`, `IN_PROGRESS`, `ACTIVE`, `DELETE_IN_PROGRESS`, or `FAILED`.", "type": "string", "enum": [ "SAVED", "IN_PROGRESS", "ACTIVE", "DELETE_IN_PROGRESS", "FAILED" ] } }, "x-akamai": { "file-path": "schemas/Configuration.yaml" } } } }, "x-akamai": { "file-path": "schemas/Configurations.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/configurations/activate": { "post": { "description": "Activate a Cloud Wrapper configuration. It takes 3-4 hours for the configuration to complete. You can use the configuration's `configId` to run the [Get a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/get-configuration) operation and review its `status`. Once it's `ACTIVE`, [enable the Cloud Wrapper behavior](https://techdocs.akamai.com/cloud-wrapper/docs/add-a-cloud-wrapper-behavior#enable-the-cloud-wrapper-behavior) in your property. \n\nTo deactivate a configuration, [update it](https://techdocs.akamai.com/cloud-wrapper/reference/put-configuration) and set the `activate` query string to `false`.", "operationId": "post-configuration-activations", "summary": "Activate a configuration", "tags": [ "Configurations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration-activations" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "configurationIds": [ 2419, 2418 ] }, "schema": { "additionalProperties": false, "description": "Describes activation of a specified configuration.", "type": "object", "required": [ "configurationIds" ], "properties": { "configurationIds": { "description": "Specify the configuration you want to activate.", "minItems": 1, "type": "array", "items": { "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" } } }, "x-akamai": { "file-path": "schemas/ActivateConfigurationsCommand.yaml" } } } } }, "responses": { "204": { "description": "Activation launched.", "content": { "*/*": {} } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "description": "[Unsupported media type](https://techdocs.akamai.com/cloud-wrapper/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/configurations/{configId}": { "get": { "description": "View a specific Cloud Wrapper configuration.", "operationId": "get-configuration", "summary": "Get a configuration", "tags": [ "Configurations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-configuration" }, "responses": { "200": { "description": "The response returns the configuration.", "content": { "application/json": { "example": { "capacityAlertsThreshold": 75, "comments": "Real traffic with MultiCDN authentication", "configName": "example-prod-live", "contractId": "C-0N7RAC71", "id": 2553, "lastActivatedBy": "adevi", "lastActivatedDate": "2022-04-08T10:25:00.000Z", "lastUpdatedBy": "tyamada", "lastUpdatedDate": "2022-04-08T10:25:00.000Z", "retainIdleObjects": false, "status": "ACTIVE", "notificationEmails": [], "propertyIds": [ "123456" ], "multiCdnSettings": { "arlId": 112997, "enableSoftAlerts": true, "bocc": { "enabled": false }, "dataStreams": { "enabled": true, "samplingRate": 100, "dataStreamIds": [ 33002 ] }, "cdns": [ { "cdnCode": "dn003", "enabled": true, "httpsOnly": false, "ipAclCidrs": [], "cdnAuthKeys": [ { "authKeyName": "Limelight-Key" } ] }, { "cdnCode": "dn004", "enabled": true, "httpsOnly": false, "cdnAuthKeys": [], "ipAclCidrs": [ "123.45.678.901", "123.45.67.8/24", "2001:db8:c12c:2059:1737:8cf:581c:82e9/32" ] } ], "origins": [ { "hostname": "example.com", "originId": "origin656", "propertyId": 123456 } ] }, "locations": [ { "comments": "Real customer traffic", "mapName": "cw-s-use", "trafficTypeId": 2, "capacity": { "unit": "GB", "value": 500 } } ] }, "schema": { "additionalProperties": false, "description": "Encompasses the Cloud Wrapper configuration.", "type": "object", "required": [ "comments", "contractId", "locations", "configName", "propertyIds" ], "properties": { "capacityAlertsThreshold": { "description": "Represents the threshold for sending alerts.", "format": "int64", "maximum": 100, "minimum": 50, "nullable": true, "type": "integer" }, "comments": { "description": "Additional information provided by user which can help to differentiate or track changes of the configuration.", "maxLength": 255, "minLength": 1, "type": "string" }, "configId": { "description": "The unique ID that Akamai generated for your Cloud Wrapper configuration.", "type": "integer" }, "configName": { "description": "The name of the configuration (property) you've set up to deliver your content. This is the `propertyName` you set when you [create](https://techdocs.akamai.com/property-mgr/reference/post-properties) the property.", "type": "string" }, "contractId": { "description": "Contract ID with Cloud Wrapper entitlement.", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "lastActivatedBy": { "description": "User to last activate the configuration.", "type": "string" }, "lastActivatedDate": { "description": "The last time you successfully activated the configuration, in ISO 8601 format.", "format": "date-time", "type": "string" }, "lastUpdatedBy": { "description": "User to last modify the configuration.", "type": "string" }, "lastUpdatedDate": { "description": "The last time you edited the configuration, in ISO 8601 format.", "format": "date-time", "type": "string" }, "locations": { "description": "The [list of locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) you've applied in the configuration. Any locations you include need to have Cloud Wrapper capacity pre-approved on the contract you've selected.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Location configuration that describes property and traffic type.", "type": "object", "required": [ "comments", "capacity", "trafficTypeId", "mapName" ], "properties": { "capacity": { "additionalProperties": false, "description": "The capacity assigned to this configuration's location. [List capacity](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory) to view the `approvedCapacity` and `assignedCapacity` values.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } }, "comments": { "description": "Additional comments provided by user.", "maxLength": 255, "minLength": 1, "type": "string" }, "mapName": { "description": "Name of the map used for the Cloud Wrapper geographic region.", "type": "string" }, "trafficTypeId": { "description": "Unique identifier for the location and traffic type combination. You can run the [list locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) operation to see your available combinations.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ResponseConfigLocation.yaml" } } }, "multiCdnSettings": { "additionalProperties": false, "description": "Specify details about the Multi CDN settings.", "nullable": true, "type": "object", "required": [ "bocc", "cdns", "dataStreams", "origins", "arlId" ], "properties": { "advancedSettings": { "additionalProperties": false, "description": "Describes advanced settings. Note that this field is available only for internal users.", "type": "object", "required": [ "denyResponseCode" ], "properties": { "advancedXmlPost": { "description": "Text appended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "advancedXmlPre": { "description": "Text prepended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "amdLiveSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver live streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentDurationDashCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationHLSCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationSmoothCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDLive.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdLiveSetting.yaml" } }, "amdVodSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver on-demand streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDVod.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdVodSetting.yaml" } }, "baseDirectory": { "additionalProperties": false, "description": "Specifies the [base path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of content on your origin server.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the base path of content on your origin server. The value needs to begin and end with a slash (/) character.", "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/BaseDirectory.yaml" } }, "cacheKeyQueryParams": { "additionalProperties": false, "description": "Consolidates cached objects based on specified sets of [query parameters](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params).", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "Configure how sets of query string parameters translate to cache keys. See [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params) for details on applicable values.", "type": "string", "enum": [ "IGNORE", "IGNORE_ALL", "INCLUDE", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ] }, "exactMatch": { "description": "When enabled, `parameters` needs to match exactly. Keep disabled to match string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "parameters": { "description": "Specifies the set of parameter field names to include in or exclude from the cache key. By default, these match the field names as string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "minItems": 1, "nullable": true, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/CacheKeyQueryParams.yaml" } }, "denyResponseCode": { "description": "The code of a deny response, either `403` or `429`.", "type": "integer", "enum": [ 403, 429 ] }, "downloadDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Download Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsDD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "objectSize": { "description": "Optimize based on the size of the object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsDD.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/DownloadDeliverySetting.yaml" } }, "objectDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Object Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/ObjectDeliverySetting.yaml" } }, "rewriteUrl": { "additionalProperties": false, "description": "Modifies the [path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of incoming requests to forward to your origin server.", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "The action to perform on the path. Either `REPLACE`, `REMOVE`, `PREPEND`, `REWRITE` or `REGEX_REPLACE`.", "type": "string", "enum": [ "REPLACE", "REMOVE", "PREPEND", "REWRITE", "REGEX_REPLACE" ] }, "keepQueryString": { "description": "Enable this to keep the original path's query parameters. You can't enable this if you've set this behavior to `REWRITE`.", "nullable": true, "type": "boolean" }, "match": { "description": "When the behavior is `REMOVE` or `REPLACE`, this specifies the part of the incoming path you'd like to remove or modify.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "matchMultiple": { "description": "When enabled, replaces all potential matches rather than only the first. For this behavior it's either: `REMOVE`, `REPLACE`, or `REGEX_REPLACE`.", "nullable": true, "type": "boolean" }, "matchRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this specifies the Perl-compatible regular expression to replace with `targetRegex`.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPath": { "description": "When the behavior is set to `REPLACE`, this path replaces whatever the match field matches in the incoming request's path.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPathPrepend": { "description": "When the behavior is set to `PREPEND`, this specifies a path to prepend to the incoming request's URL.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this replaces whatever the `matchRegex` field matches.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetUrl": { "description": "When the behavior is set to `REWRITE`, this specifies the full path to request from the origin.", "nullable": true, "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/RewriteUrl.yaml" } } }, "x-akamai": { "file-path": "schemas/AdvancedSettings.yaml", "status": "INTERNAL" } }, "arlId": { "description": "Unique identifier for the Akamai Resource Locator.", "nullable": true, "type": "integer" }, "bocc": { "additionalProperties": false, "description": "Specify diagnostic data beacons details. It enables real time beaconing for [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "object", "required": [ "samplingFrequency", "requestType", "forwardType", "conditionalSamplingFrequency", "enabled" ], "properties": { "conditionalSamplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] }, "enabled": { "description": "Enable diagnostic data beacons for consumption by the [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "boolean" }, "forwardType": { "description": "Select whether to beacon diagnostics data for internal `ORIGIN_ONLY`, `MIDGRESS_ONLY`, or both `ORIGIN_AND_MIDGRESS` forwards.", "type": "string", "enum": [ "ORIGIN_ONLY", "MIDGRESS_ONLY", "ORIGIN_AND_MIDGRESS" ] }, "requestType": { "description": "Select whether to beacon diagnostics data for `EDGE_ONLY` or `EDGE_AND_MIDGRESS` requests.", "type": "string", "enum": [ "EDGE_ONLY", "EDGE_AND_MIDGRESS" ] }, "samplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] } }, "x-akamai": { "file-path": "schemas/Bocc.yaml", "status": "INTERNAL" } }, "cdns": { "description": "List of CDN added for the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "cdnCode", "enabled" ], "properties": { "cdnAuthKeys": { "description": "List of auth keys configured for the CDN.", "minItems": 0, "type": "array", "items": { "oneOf": [ { "additionalProperties": false, "title": "Use an existing auth key", "type": "object", "required": [ "authKeyName" ], "properties": { "authKeyName": { "description": "Name of the auth key.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/AuthKey.yaml" } }, { "additionalProperties": false, "title": "Create new auth keys", "type": "object", "required": [ "authKeyName", "expiryDate", "headerName" ], "properties": { "authKeyName": { "description": "Name of the new auth key.", "type": "string", "writeOnly": true }, "expiryDate": { "description": "ISO 8601 expiration date of the key.", "format": "date-time", "type": "string" }, "headerName": { "description": "The header name you want to use for the auth key. If you leave this out, the API uses the name of the third-party CDN you specified via the `cdnCode` in your Cloud Wrapper [configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration).", "type": "string", "writeOnly": true }, "secret": { "description": "A unique, 24 character hexadecimal string to use with CDN auth keys.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/NewAuthKey.yaml" } } ] } }, "cdnCode": { "description": "Unique identifier for the CDN. [List CDN providers](https://techdocs.akamai.com/cloud-wrapper/reference/get-providers) for a list of available CDNs.", "type": "string" }, "enabled": { "description": "Enable CDN.", "type": "boolean" }, "httpsOnly": { "description": "Specify whether CDN communication is HTTPS only.", "type": "boolean" }, "ipAclCidrs": { "description": "Configure an access control list using IP addresses in CIDR notation. You get a denial of service error if your CDN makes requests from IPs that aren't part of the list configured here. You need to maintain the IP/CIDR list in this configuration to ensure it's up-to-date with your CDN's list. Cloud Wrapper can receive traffic from your downstream CDN using both IPv4 and IPv6 addresses. Include both IPv4 and IPv6 CDN addresses in your ACLs. View the [FAQ](https://techdocs.akamai.com/cloud-wrapper/docs/faq-and-considerations) for information about setting up auth alerts.", "minItems": 0, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/ConfigCdn.yaml" } } }, "dataStreams": { "additionalProperties": false, "description": "Specifies data streams details.", "type": "object", "required": [ "dataStreamIds", "enabled", "samplingRate" ], "properties": { "dataStreamIds": { "description": "The unique identifiers Akamai assigns to the DataStreams. Use the [DataStream API](https://techdocs.akamai.com/datastream2/reference/api) to view stream configurations.", "minItems": 1, "type": "array", "items": { "format": "int64", "maximum": 10000000000, "minimum": 1, "type": "integer" } }, "enabled": { "description": "Enables DataStream reporting.", "type": "boolean" }, "samplingRate": { "description": "Specifies the percentage of log data you want to collect for this configuration.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/DataStreams.yaml" } }, "enableSoftAlerts": { "default": false, "description": "Option to opt out of alerts based on soft limits of bandwidth usage.", "type": "boolean" }, "origins": { "description": "List of origins corresponding to the properties selected in the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hostname", "originId", "propertyId" ], "properties": { "hostname": { "description": "The origin hostname you've set for your origin server in your Property Manager delivery configuration.", "type": "string" }, "originId": { "description": "The origin identifier that's used to generate Multi CDN hostnames.", "maxLength": 10, "minLength": 3, "type": "string" }, "propertyId": { "description": "The [Property ID](https://techdocs.akamai.com/cloud-wrapper/reference/get-properties) of the property the origin belongs to.", "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ConfigOrigin.yaml" } } } }, "x-akamai": { "file-path": "schemas/ConfigMultiCdnSettingsResponse.yaml" } }, "notificationEmails": { "description": "Email addresses to receive notifications.", "minItems": 0, "type": "array", "items": { "format": "email", "type": "string" } }, "propertyIds": { "description": "List of [properties](https://techdocs.akamai.com/cloud-wrapper/reference/concepts) belonging to eligible delivery products.", "minItems": 1, "type": "array", "items": { "maxLength": 1000000000, "minLength": 1, "type": "string" } }, "retainIdleObjects": { "default": false, "description": "Retain idle objects beyond their max idle lifetime.", "type": "boolean" }, "status": { "description": "Current provisioning state of the configuration, either `SAVED`, `IN_PROGRESS`, `ACTIVE`, `DELETE_IN_PROGRESS`, or `FAILED`.", "type": "string", "enum": [ "SAVED", "IN_PROGRESS", "ACTIVE", "DELETE_IN_PROGRESS", "FAILED" ] } }, "x-akamai": { "file-path": "schemas/Configuration.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "The unique identifier Akamai assigns to your Cloud Wrapper configuration.", "example": "{{configId}}", "in": "path", "name": "configId", "required": true, "schema": { "example": 12345, "format": "int32", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/configId-path.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "put": { "description": "Update a saved or inactive configuration.", "operationId": "put-configuration", "summary": "Update a configuration", "tags": [ "Configurations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/put-configuration" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "activate": false, "capacityAlertsThreshold": 75, "comments": "Real traffic", "retainIdleObjects": false, "notificationEmails": [], "propertyIds": [ "123456" ], "multiCdnSettings": { "bocc": { "enabled": false }, "dataStreams": { "enabled": false }, "cdns": [ { "cdnCode": "dn002", "enabled": true, "httpsOnly": false, "cdnAuthKeys": [], "ipAclCidrs": [ "2001:db8:901c:e38c:77ca:bf91:add3:cd72/32" ] } ], "origins": [ { "hostname": "example-live.com", "originId": "origin770", "propertyId": 123456 } ] }, "locations": [ { "comments": "Real VOD traffic", "trafficTypeId": 4, "capacity": { "unit": "GB", "value": 1 } } ] }, "schema": { "additionalProperties": false, "description": "Describes the fields you can update in a configuration.", "type": "object", "required": [ "comments", "locations", "propertyIds" ], "properties": { "capacityAlertsThreshold": { "description": "Capacity Alerts enablement information for the configuration.", "example": "{{capacityAlertsThreshold}}", "format": "int64", "maximum": 100, "minimum": 50, "nullable": true, "type": "integer" }, "comments": { "description": "Additional information you provide to differentiate or track changes of the configuration.", "example": "{{comments}}", "maxLength": 255, "minLength": 1, "type": "string" }, "locations": { "description": "List of [locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) to use with the configuration. Locations need to have a [pre-approved capacity](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory) for the selected contract.", "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Location configuration that describes property and traffic type.", "type": "object", "required": [ "comments", "capacity", "trafficTypeId" ], "properties": { "capacity": { "additionalProperties": false, "description": "The capacity assigned to this configuration's location. [List capacity](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory) to view the `approvedCapacity` and `assignedCapacity` capacities.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } }, "comments": { "description": "Additional comments provided by user.", "maxLength": 255, "minLength": 1, "type": "string" }, "trafficTypeId": { "description": "Unique identifier for the location and traffic type combination. You can [list locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) to see your available combinations.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ConfigLocation.yaml" } } }, "multiCdnSettings": { "additionalProperties": false, "description": "Specify details about the Multi CDN settings.", "nullable": true, "type": "object", "required": [ "bocc", "cdns", "dataStreams", "origins" ], "properties": { "advancedSettings": { "additionalProperties": false, "description": "Specifies advanced settings. This is only available to Akamai Global Services Support.", "type": "object", "required": [ "denyResponseCode" ], "properties": { "advancedXmlPost": { "description": "Text appended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "advancedXmlPre": { "description": "Text prepended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "amdLiveSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver live streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentDurationDashCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationHLSCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationSmoothCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDLive.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdLiveSetting.yaml" } }, "amdVodSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver on-demand streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDVod.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdVodSetting.yaml" } }, "baseDirectory": { "additionalProperties": false, "description": "Specifies the [base path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of content on your origin server.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the base path of content on your origin server. The value needs to begin and end with a slash (/) character.", "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/BaseDirectory.yaml" } }, "cacheKeyQueryParams": { "additionalProperties": false, "description": "Consolidates cached objects based on specified sets of [query parameters](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params).", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "Configure how sets of query string parameters translate to cache keys. See [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params) for details on applicable values.", "type": "string", "enum": [ "IGNORE", "IGNORE_ALL", "INCLUDE", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ] }, "exactMatch": { "description": "When enabled, `parameters` needs to match exactly. Keep disabled to match string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "parameters": { "description": "Specifies the set of parameter field names to include in or exclude from the cache key. By default, these match the field names as string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "minItems": 1, "nullable": true, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/CacheKeyQueryParams.yaml" } }, "denyResponseCode": { "description": "The code of a deny response, either `403` or `429`.", "type": "integer", "enum": [ 403, 429 ] }, "downloadDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Download Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsDD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "objectSize": { "description": "Optimize based on the size of the object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsDD.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/DownloadDeliverySetting.yaml" } }, "objectDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Object Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/ObjectDeliverySetting.yaml" } }, "rewriteUrl": { "additionalProperties": false, "description": "Modifies the [path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of incoming requests to forward to your origin server.", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "The action to perform on the path. Either `REPLACE`, `REMOVE`, `PREPEND`, `REWRITE` or `REGEX_REPLACE`.", "type": "string", "enum": [ "REPLACE", "REMOVE", "PREPEND", "REWRITE", "REGEX_REPLACE" ] }, "keepQueryString": { "description": "Enable this to keep the original path's query parameters. You can't enable this if you've set this behavior to `REWRITE`.", "nullable": true, "type": "boolean" }, "match": { "description": "When the behavior is `REMOVE` or `REPLACE`, this specifies the part of the incoming path you'd like to remove or modify.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "matchMultiple": { "description": "When enabled, replaces all potential matches rather than only the first. For this behavior it's either: `REMOVE`, `REPLACE`, or `REGEX_REPLACE`.", "nullable": true, "type": "boolean" }, "matchRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this specifies the Perl-compatible regular expression to replace with `targetRegex`.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPath": { "description": "When the behavior is set to `REPLACE`, this path replaces whatever the match field matches in the incoming request's path.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPathPrepend": { "description": "When the behavior is set to `PREPEND`, this specifies a path to prepend to the incoming request's URL.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this replaces whatever the `matchRegex` field matches.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetUrl": { "description": "When the behavior is set to `REWRITE`, this specifies the full path to request from the origin.", "nullable": true, "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/RewriteUrl.yaml" } } }, "x-akamai": { "file-path": "schemas/AdvancedSettings.yaml", "status": "INTERNAL" } }, "bocc": { "additionalProperties": false, "description": "Specify diagnostic data beacons details. This enables real-time beaconing for [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "object", "required": [ "samplingFrequency", "requestType", "forwardType", "conditionalSamplingFrequency", "enabled" ], "properties": { "conditionalSamplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] }, "enabled": { "description": "Enable diagnostic data beacons for consumption by the [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "boolean" }, "forwardType": { "description": "Select whether to beacon diagnostics data for internal `ORIGIN_ONLY`, `MIDGRESS_ONLY`, or both `ORIGIN_AND_MIDGRESS` forwards.", "type": "string", "enum": [ "ORIGIN_ONLY", "MIDGRESS_ONLY", "ORIGIN_AND_MIDGRESS" ] }, "requestType": { "description": "Select whether to beacon diagnostics data for `EDGE_ONLY` or `EDGE_AND_MIDGRESS` requests.", "type": "string", "enum": [ "EDGE_ONLY", "EDGE_AND_MIDGRESS" ] }, "samplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] } }, "x-akamai": { "file-path": "schemas/Bocc.yaml", "status": "INTERNAL" } }, "cdns": { "description": "List of CDN added for the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "cdnCode", "enabled" ], "properties": { "cdnAuthKeys": { "description": "List of auth keys configured for the CDN.", "minItems": 0, "type": "array", "items": { "oneOf": [ { "additionalProperties": false, "title": "Use an existing auth key", "type": "object", "required": [ "authKeyName" ], "properties": { "authKeyName": { "description": "Name of the auth key.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/AuthKey.yaml" } }, { "additionalProperties": false, "title": "Create new auth keys", "type": "object", "required": [ "authKeyName", "expiryDate", "headerName" ], "properties": { "authKeyName": { "description": "Name of the new auth key.", "type": "string", "writeOnly": true }, "expiryDate": { "description": "ISO 8601 expiration date of the key.", "format": "date-time", "type": "string" }, "headerName": { "description": "The header name you want to use for the auth key. If you leave this out, the API uses the name of the third-party CDN you specified via the `cdnCode` in your Cloud Wrapper [configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration).", "type": "string", "writeOnly": true }, "secret": { "description": "A unique, 24 character hexadecimal string to use with CDN auth keys.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/NewAuthKey.yaml" } } ] } }, "cdnCode": { "description": "Unique identifier for the CDN. [List CDN providers](https://techdocs.akamai.com/cloud-wrapper/reference/get-providers) for a list of available CDNs.", "type": "string" }, "enabled": { "description": "Enable CDN.", "type": "boolean" }, "httpsOnly": { "description": "Specify whether CDN communication is HTTPS only.", "type": "boolean" }, "ipAclCidrs": { "description": "Configure an access control list using IP addresses in CIDR notation. You get a denial of service error if your CDN makes requests from IPs that aren't part of the list configured here. You need to maintain the IP/CIDR list in this configuration to ensure it's up-to-date with your CDN's list. Cloud Wrapper can receive traffic from your downstream CDN using both IPv4 and IPv6 addresses. Include both IPv4 and IPv6 CDN addresses in your ACLs. View the [FAQ](https://techdocs.akamai.com/cloud-wrapper/docs/faq-and-considerations) for information about setting up auth alerts.", "minItems": 0, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/ConfigCdn.yaml" } } }, "dataStreams": { "additionalProperties": false, "description": "Specifies data streams details.", "type": "object", "required": [ "dataStreamIds", "enabled", "samplingRate" ], "properties": { "dataStreamIds": { "description": "The unique identifiers Akamai assigns to the DataStreams. Use the [DataStream API](https://techdocs.akamai.com/datastream2/reference/api) to view stream configurations.", "minItems": 1, "type": "array", "items": { "format": "int64", "maximum": 10000000000, "minimum": 1, "type": "integer" } }, "enabled": { "description": "Enables DataStream reporting.", "type": "boolean" }, "samplingRate": { "description": "Specifies the percentage of log data you want to collect for this configuration.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/DataStreams.yaml" } }, "enableSoftAlerts": { "default": false, "description": "Option to opt out of alerts based on soft limits of bandwidth usage.", "type": "boolean" }, "origins": { "description": "List of origins corresponding to the properties selected in the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hostname", "originId", "propertyId" ], "properties": { "hostname": { "description": "The origin hostname you've set for your origin server in your Property Manager delivery configuration.", "type": "string" }, "originId": { "description": "The origin identifier that's used to generate Multi CDN hostnames.", "maxLength": 10, "minLength": 3, "type": "string" }, "propertyId": { "description": "The [Property ID](https://techdocs.akamai.com/cloud-wrapper/reference/get-properties) of the property the origin belongs to.", "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ConfigOrigin.yaml" } } } }, "x-akamai": { "file-path": "schemas/ConfigMultiCdnSettings.yaml" } }, "notificationEmails": { "description": "Email addresses to receive notifications.", "minItems": 0, "type": "array", "items": { "format": "email", "type": "string" } }, "propertyIds": { "description": "List of properties belonging to supported delivery products. Properties need to be unique across configurations. For example, a property can associate with a single Cloud Wrapper configuration. Properties don't need be from the same contract specified for the configuration.", "minItems": 1, "type": "array", "items": { "maximum": 1000000000, "minimum": 1, "type": "string" } }, "retainIdleObjects": { "default": false, "description": "Retain idle objects beyond their max idle lifetime.", "example": "{{retainIdleObjects}}", "type": "boolean" } }, "x-akamai": { "file-path": "schemas/UpdateConfiguration.yaml" } } } } }, "responses": { "200": { "description": "The response returns the updated configuration.", "content": { "application/json": { "example": { "capacityAlertsThreshold": 75, "comments": "Real traffic", "configName": "example-prod-live", "contractId": "C-0N7RAC7", "id": 2667, "lastActivatedBy": null, "lastActivatedDate": null, "lastUpdatedBy": "adevi", "lastUpdatedDate": "2022-06-10T13:33:36.635Z", "retainIdleObjects": false, "status": "IN_PROGRESS", "notificationEmails": [ "johndoe@example.com" ], "propertyIds": [ "123456" ], "multiCdnSettings": { "arlId": null, "enableSoftAlerts": false, "bocc": { "enabled": false }, "dataStreams": { "enabled": false }, "cdns": [ { "cdnCode": "dn002", "enabled": true, "httpsOnly": false, "cdnAuthKeys": [], "ipAclCidrs": [ "2001:db8:b07b:ba78:9ed6:cfe:1ffa:dccd/32" ] } ], "origins": [ { "hostname": "example-live.com", "originId": "origin770", "propertyId": 123456 } ] }, "locations": [ { "comments": "Real VOD traffic", "mapName": "cw-s-usw-live", "trafficTypeId": 4, "capacity": { "unit": "GB", "value": 800 } } ] }, "schema": { "additionalProperties": false, "description": "Encompasses the Cloud Wrapper configuration.", "type": "object", "required": [ "comments", "contractId", "locations", "configName", "propertyIds" ], "properties": { "capacityAlertsThreshold": { "description": "Represents the threshold for sending alerts.", "format": "int64", "maximum": 100, "minimum": 50, "nullable": true, "type": "integer" }, "comments": { "description": "Additional information provided by user which can help to differentiate or track changes of the configuration.", "maxLength": 255, "minLength": 1, "type": "string" }, "configId": { "description": "The unique ID that Akamai generated for your Cloud Wrapper configuration.", "type": "integer" }, "configName": { "description": "The name of the configuration (property) you've set up to deliver your content. This is the `propertyName` you set when you [create](https://techdocs.akamai.com/property-mgr/reference/post-properties) the property.", "type": "string" }, "contractId": { "description": "Contract ID with Cloud Wrapper entitlement.", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "lastActivatedBy": { "description": "User to last activate the configuration.", "type": "string" }, "lastActivatedDate": { "description": "The last time you successfully activated the configuration, in ISO 8601 format.", "format": "date-time", "type": "string" }, "lastUpdatedBy": { "description": "User to last modify the configuration.", "type": "string" }, "lastUpdatedDate": { "description": "The last time you edited the configuration, in ISO 8601 format.", "format": "date-time", "type": "string" }, "locations": { "description": "The [list of locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) you've applied in the configuration. Any locations you include need to have Cloud Wrapper capacity pre-approved on the contract you've selected.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Location configuration that describes property and traffic type.", "type": "object", "required": [ "comments", "capacity", "trafficTypeId", "mapName" ], "properties": { "capacity": { "additionalProperties": false, "description": "The capacity assigned to this configuration's location. [List capacity](https://techdocs.akamai.com/cloud-wrapper/reference/get-capacity-inventory) to view the `approvedCapacity` and `assignedCapacity` values.", "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The capacity unit in `GB` or `TB`.", "type": "string", "enum": [ "GB", "TB" ] }, "value": { "description": "The value of capacity.", "format": "int64", "maximum": 10000000000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/Capacity.yaml" } }, "comments": { "description": "Additional comments provided by user.", "maxLength": 255, "minLength": 1, "type": "string" }, "mapName": { "description": "Name of the map used for the Cloud Wrapper geographic region.", "type": "string" }, "trafficTypeId": { "description": "Unique identifier for the location and traffic type combination. You can run the [list locations](https://techdocs.akamai.com/cloud-wrapper/reference/get-locations) operation to see your available combinations.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ResponseConfigLocation.yaml" } } }, "multiCdnSettings": { "additionalProperties": false, "description": "Specify details about the Multi CDN settings.", "nullable": true, "type": "object", "required": [ "bocc", "cdns", "dataStreams", "origins", "arlId" ], "properties": { "advancedSettings": { "additionalProperties": false, "description": "Describes advanced settings. Note that this field is available only for internal users.", "type": "object", "required": [ "denyResponseCode" ], "properties": { "advancedXmlPost": { "description": "Text appended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "advancedXmlPre": { "description": "Text prepended to the [Advanced Metadata](https://techdocs.akamai.com/property-mgr/reference/latest-advanced) XML.", "type": "string" }, "amdLiveSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver live streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentDurationDashCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationHLSCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentDurationSmoothCustom": { "description": "Customizes the number of seconds for the segment.", "maximum": 10, "minimum": 1, "type": "integer" }, "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDLive.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdLiveSetting.yaml" } }, "amdVodSetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver on-demand streaming media using [Adaptive Media Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsAMD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "segmentSizeDASH": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeHLS": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] }, "segmentSizeSmooth": { "description": "Specifies the size of the media object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsAMDVod.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/AmdVodSetting.yaml" } }, "baseDirectory": { "additionalProperties": false, "description": "Specifies the [base path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of content on your origin server.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the base path of content on your origin server. The value needs to begin and end with a slash (/) character.", "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/BaseDirectory.yaml" } }, "cacheKeyQueryParams": { "additionalProperties": false, "description": "Consolidates cached objects based on specified sets of [query parameters](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params).", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "Configure how sets of query string parameters translate to cache keys. See [cacheKeyQueryParams](https://techdocs.akamai.com/property-mgr/reference/latest-cache-key-query-params) for details on applicable values.", "type": "string", "enum": [ "IGNORE", "IGNORE_ALL", "INCLUDE", "INCLUDE_ALL_PRESERVE_ORDER", "INCLUDE_ALL_ALPHABETIZE_ORDER" ] }, "exactMatch": { "description": "When enabled, `parameters` needs to match exactly. Keep disabled to match string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "nullable": true, "type": "boolean" }, "parameters": { "description": "Specifies the set of parameter field names to include in or exclude from the cache key. By default, these match the field names as string prefixes. You can only apply this if `behavior` is set to `INCLUDE` or `IGNORE`.", "minItems": 1, "nullable": true, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/CacheKeyQueryParams.yaml" } }, "denyResponseCode": { "description": "The code of a deny response, either `403` or `429`.", "type": "integer", "enum": [ 403, 429 ] }, "downloadDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Download Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "contentCharacteristicsDD": { "additionalProperties": false, "description": "Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance.", "nullable": true, "type": "object", "properties": { "objectSize": { "description": "Optimize based on the size of the object retrieved from the origin. Either `LESS_THAN_1MB`, `ONE_MB_TO_TEN_MB`, `TEN_MB_TO_100_MB`, `GREATER_THAN_100MB`, `OTHER` or `UNKNOWN`.", "type": "string", "enum": [ "LESS_THAN_1MB", "ONE_MB_TO_TEN_MB", "TEN_MB_TO_100_MB", "GREATER_THAN_100MB", "OTHER", "UNKNOWN" ] } }, "x-akamai": { "file-path": "schemas/ContentCharacteristicsDD.yaml" } }, "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/DownloadDeliverySetting.yaml" } }, "objectDeliverySetting": { "additionalProperties": false, "description": "Settings you've defined in a property to deliver your content using [Object Delivery](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#3-set-up-a-delivery-configuration).", "nullable": true, "type": "object", "properties": { "readTimeout": { "additionalProperties": false, "description": "After a requesting forward server has established a connection with an edge server, this specifies how long the edge server should wait for a response.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } }, "timeout": { "additionalProperties": false, "description": "Sets the HTTP connect timeout.", "nullable": true, "type": "object", "required": [ "value" ], "properties": { "value": { "description": "Specifies the timeout value followed by `s`, `m`, `h`, or `d` for seconds, minutes, hours, or days. This value should never be zero.", "pattern": "^[1-9][0-9]*[smhd]$", "type": "string" } }, "x-akamai": { "file-path": "schemas/Timeout.yaml" } } }, "x-akamai": { "file-path": "schemas/ObjectDeliverySetting.yaml" } }, "rewriteUrl": { "additionalProperties": false, "description": "Modifies the [path](https://techdocs.akamai.com/property-mgr/reference/latest-base-directory) of incoming requests to forward to your origin server.", "nullable": true, "type": "object", "required": [ "behavior" ], "properties": { "behavior": { "description": "The action to perform on the path. Either `REPLACE`, `REMOVE`, `PREPEND`, `REWRITE` or `REGEX_REPLACE`.", "type": "string", "enum": [ "REPLACE", "REMOVE", "PREPEND", "REWRITE", "REGEX_REPLACE" ] }, "keepQueryString": { "description": "Enable this to keep the original path's query parameters. You can't enable this if you've set this behavior to `REWRITE`.", "nullable": true, "type": "boolean" }, "match": { "description": "When the behavior is `REMOVE` or `REPLACE`, this specifies the part of the incoming path you'd like to remove or modify.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "matchMultiple": { "description": "When enabled, replaces all potential matches rather than only the first. For this behavior it's either: `REMOVE`, `REPLACE`, or `REGEX_REPLACE`.", "nullable": true, "type": "boolean" }, "matchRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this specifies the Perl-compatible regular expression to replace with `targetRegex`.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPath": { "description": "When the behavior is set to `REPLACE`, this path replaces whatever the match field matches in the incoming request's path.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetPathPrepend": { "description": "When the behavior is set to `PREPEND`, this specifies a path to prepend to the incoming request's URL.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetRegex": { "description": "When the behavior is set to `REGEX_REPLACE`, this replaces whatever the `matchRegex` field matches.", "nullable": true, "pattern": "^/.*/$", "type": "string" }, "targetUrl": { "description": "When the behavior is set to `REWRITE`, this specifies the full path to request from the origin.", "nullable": true, "pattern": "^/.*/$", "type": "string" } }, "x-akamai": { "file-path": "schemas/RewriteUrl.yaml" } } }, "x-akamai": { "file-path": "schemas/AdvancedSettings.yaml", "status": "INTERNAL" } }, "arlId": { "description": "Unique identifier for the Akamai Resource Locator.", "nullable": true, "type": "integer" }, "bocc": { "additionalProperties": false, "description": "Specify diagnostic data beacons details. It enables real time beaconing for [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "object", "required": [ "samplingFrequency", "requestType", "forwardType", "conditionalSamplingFrequency", "enabled" ], "properties": { "conditionalSamplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] }, "enabled": { "description": "Enable diagnostic data beacons for consumption by the [Broadcast Operations Control Center](https://www.akamai.com/global-services/services/broadcast-operations-command-center).", "type": "boolean" }, "forwardType": { "description": "Select whether to beacon diagnostics data for internal `ORIGIN_ONLY`, `MIDGRESS_ONLY`, or both `ORIGIN_AND_MIDGRESS` forwards.", "type": "string", "enum": [ "ORIGIN_ONLY", "MIDGRESS_ONLY", "ORIGIN_AND_MIDGRESS" ] }, "requestType": { "description": "Select whether to beacon diagnostics data for `EDGE_ONLY` or `EDGE_AND_MIDGRESS` requests.", "type": "string", "enum": [ "EDGE_ONLY", "EDGE_AND_MIDGRESS" ] }, "samplingFrequency": { "description": "The sampling frequency of requests and forwards for `EDGE`, `MIDGRESS`, and `ORIGIN` beacons. Set to `ONE_TENTH`, or choose `ZERO` to disable beacons.", "type": "string", "enum": [ "ZERO", "ONE_TENTH" ] } }, "x-akamai": { "file-path": "schemas/Bocc.yaml", "status": "INTERNAL" } }, "cdns": { "description": "List of CDN added for the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "cdnCode", "enabled" ], "properties": { "cdnAuthKeys": { "description": "List of auth keys configured for the CDN.", "minItems": 0, "type": "array", "items": { "oneOf": [ { "additionalProperties": false, "title": "Use an existing auth key", "type": "object", "required": [ "authKeyName" ], "properties": { "authKeyName": { "description": "Name of the auth key.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/AuthKey.yaml" } }, { "additionalProperties": false, "title": "Create new auth keys", "type": "object", "required": [ "authKeyName", "expiryDate", "headerName" ], "properties": { "authKeyName": { "description": "Name of the new auth key.", "type": "string", "writeOnly": true }, "expiryDate": { "description": "ISO 8601 expiration date of the key.", "format": "date-time", "type": "string" }, "headerName": { "description": "The header name you want to use for the auth key. If you leave this out, the API uses the name of the third-party CDN you specified via the `cdnCode` in your Cloud Wrapper [configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration).", "type": "string", "writeOnly": true }, "secret": { "description": "A unique, 24 character hexadecimal string to use with CDN auth keys.", "type": "string", "writeOnly": true } }, "x-akamai": { "file-path": "schemas/NewAuthKey.yaml" } } ] } }, "cdnCode": { "description": "Unique identifier for the CDN. [List CDN providers](https://techdocs.akamai.com/cloud-wrapper/reference/get-providers) for a list of available CDNs.", "type": "string" }, "enabled": { "description": "Enable CDN.", "type": "boolean" }, "httpsOnly": { "description": "Specify whether CDN communication is HTTPS only.", "type": "boolean" }, "ipAclCidrs": { "description": "Configure an access control list using IP addresses in CIDR notation. You get a denial of service error if your CDN makes requests from IPs that aren't part of the list configured here. You need to maintain the IP/CIDR list in this configuration to ensure it's up-to-date with your CDN's list. Cloud Wrapper can receive traffic from your downstream CDN using both IPv4 and IPv6 addresses. Include both IPv4 and IPv6 CDN addresses in your ACLs. View the [FAQ](https://techdocs.akamai.com/cloud-wrapper/docs/faq-and-considerations) for information about setting up auth alerts.", "minItems": 0, "type": "array", "items": { "type": "string" } } }, "x-akamai": { "file-path": "schemas/ConfigCdn.yaml" } } }, "dataStreams": { "additionalProperties": false, "description": "Specifies data streams details.", "type": "object", "required": [ "dataStreamIds", "enabled", "samplingRate" ], "properties": { "dataStreamIds": { "description": "The unique identifiers Akamai assigns to the DataStreams. Use the [DataStream API](https://techdocs.akamai.com/datastream2/reference/api) to view stream configurations.", "minItems": 1, "type": "array", "items": { "format": "int64", "maximum": 10000000000, "minimum": 1, "type": "integer" } }, "enabled": { "description": "Enables DataStream reporting.", "type": "boolean" }, "samplingRate": { "description": "Specifies the percentage of log data you want to collect for this configuration.", "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/DataStreams.yaml" } }, "enableSoftAlerts": { "default": false, "description": "Option to opt out of alerts based on soft limits of bandwidth usage.", "type": "boolean" }, "origins": { "description": "List of origins corresponding to the properties selected in the configuration.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hostname", "originId", "propertyId" ], "properties": { "hostname": { "description": "The origin hostname you've set for your origin server in your Property Manager delivery configuration.", "type": "string" }, "originId": { "description": "The origin identifier that's used to generate Multi CDN hostnames.", "maxLength": 10, "minLength": 3, "type": "string" }, "propertyId": { "description": "The [Property ID](https://techdocs.akamai.com/cloud-wrapper/reference/get-properties) of the property the origin belongs to.", "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" } }, "x-akamai": { "file-path": "schemas/ConfigOrigin.yaml" } } } }, "x-akamai": { "file-path": "schemas/ConfigMultiCdnSettingsResponse.yaml" } }, "notificationEmails": { "description": "Email addresses to receive notifications.", "minItems": 0, "type": "array", "items": { "format": "email", "type": "string" } }, "propertyIds": { "description": "List of [properties](https://techdocs.akamai.com/cloud-wrapper/reference/concepts) belonging to eligible delivery products.", "minItems": 1, "type": "array", "items": { "maxLength": 1000000000, "minLength": 1, "type": "string" } }, "retainIdleObjects": { "default": false, "description": "Retain idle objects beyond their max idle lifetime.", "type": "boolean" }, "status": { "description": "Current provisioning state of the configuration, either `SAVED`, `IN_PROGRESS`, `ACTIVE`, `DELETE_IN_PROGRESS`, or `FAILED`.", "type": "string", "enum": [ "SAVED", "IN_PROGRESS", "ACTIVE", "DELETE_IN_PROGRESS", "FAILED" ] } }, "x-akamai": { "file-path": "schemas/Configuration.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "415": { "description": "[Unsupported media type](https://techdocs.akamai.com/cloud-wrapper/reference/415). You've used an unsupported request or response content type, such as `application/xml`. Try the operation again using `application/json`.", "content": { "application/problem+json": { "example": { "detail": "Unsupported media type", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 415, "title": "Unsupported Media Type", "type": "unsupported_media_type" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/415.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "The unique identifier Akamai assigns to your Cloud Wrapper configuration.", "example": "{{configId}}", "in": "path", "name": "configId", "required": true, "schema": { "example": 12345, "format": "int32", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/configId-path.yaml" } }, { "description": "Specify if you want to activate the modified configuration, `false` by default. Otherwise, you can run the [Activate a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/post-configuration-activations) operation separately.", "example": "{{activate}}", "in": "query", "name": "activate", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/activate-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "Delete a specific Cloud Wrapper configuration. The delete can take up to three hours to complete. You can use the configuration's `configId` to run the [Get a configuration](https://techdocs.akamai.com/cloud-wrapper/reference/get-configuration) operation to check the status. `DELETE_IN_PROGRESS` indicates the request has been accepted. A 404 response indicates the configuration has been deleted. Before you delete a configuration:\n>\n> Ensure that all the properties that use it have the [`cloudWrapper`](https://techdocs.akamai.com/property-mgr/reference/latest-cloud-wrapper) behavior disabled. Then [update](https://techdocs.akamai.com/cloud-wrapper/reference/put-configuration) the configuration to deactivate it by setting the `activate` query string to `false`.", "operationId": "delete-configuration", "summary": "Delete a configuration", "tags": [ "Configurations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/delete-configuration" }, "responses": { "202": { "description": "Delete request accepted.", "content": { "*/*": {} } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "The unique identifier Akamai assigns to your Cloud Wrapper configuration.", "example": "{{configId}}", "in": "path", "name": "configId", "required": true, "schema": { "example": 12345, "format": "int32", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/configId-path.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/locations": { "get": { "description": "View the locations available to distribute your Cloud Wrapper capacity. This operation lists the available `trafficTypeId` values for use when creating configurations.", "operationId": "get-locations", "summary": "List locations", "tags": [ "Locations" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-locations" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "locations": [ { "locationId": 1, "locationName": "US East", "multiCdnLocationId": "011", "trafficTypes": [ { "mapName": "cw-s-use-live", "trafficType": "LIVE", "trafficTypeId": 1 }, { "mapName": "cw-s-use", "trafficType": "LIVE_VOD", "trafficTypeId": 2 } ] }, { "locationId": 2, "locationName": "US West", "multiCdnLocationId": "028", "trafficTypes": [ { "mapName": "cw-s-usw", "trafficType": "LIVE_VOD", "trafficTypeId": 3 }, { "mapName": "cw-s-usw-live", "trafficType": "LIVE", "trafficTypeId": 4 } ] } ] }, "schema": { "additionalProperties": false, "description": "List of all available locations.", "type": "object", "required": [ "locations" ], "properties": { "locations": { "description": "List of all available locations.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "locationId", "locationName", "trafficTypes" ], "properties": { "locationId": { "description": "Unique identifier of the location.", "format": "int64", "type": "integer" }, "locationName": { "description": "Name of the location.", "type": "string" }, "multiCdnLocationId": { "description": "Unique identifier of the multi CDN location.", "type": "string" }, "trafficTypes": { "description": "List of traffic types for the location. ", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "description": "Describes Cloud Wrapper traffic types and region maps.", "type": "object", "required": [ "mapName", "trafficTypeId", "trafficType" ], "properties": { "mapName": { "description": "The name of the map used for the Cloud Wrapper geographic region.", "type": "string" }, "trafficType": { "description": "Represents the traffic type. `LIVE` applies to low latency media traffic, such as live content. `LIVE_VOD` applies to redundant media traffic, such as video on demand content. `WEB_STANDARD_TLS` or `WEB_ENHANCED_TLS` applies to web content using Standard TLS security or Enhanced TLS security, respectively.", "type": "string", "enum": [ "LIVE", "LIVE_VOD", "WEB_STANDARD_TLS", "WEB_ENHANCED_TLS" ] }, "trafficTypeId": { "description": "The unique identifier Akamai assigned to the location and traffic type combination in your Cloud Wrapper footprint.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer" } }, "x-akamai": { "file-path": "schemas/TrafficType.yaml" } } } }, "x-akamai": { "file-path": "schemas/Location.yaml" } } } }, "x-akamai": { "file-path": "schemas/Locations.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/multi-cdn/auth-keys": { "get": { "description": "This operation shows the `cdnAuthKeys` for a specific Akamai `contractId` and specific third-party CDN (`cdnCode`). Use [auth keys](https://techdocs.akamai.com/cloud-wrapper/reference/concepts) (`cdnAuthKeys`) to generate the header that authenticates a request between a third-party CDN and your Cloud Wrapper cache, on the Akamai CDN.", "operationId": "get-auth-keys", "summary": "Get an auth key", "tags": [ "Multi-CDN" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-auth-keys" }, "responses": { "200": { "description": "The response includes the list of `cdnAuthKeys`.", "content": { "application/json": { "example": { "cdnAuthKeys": [ { "authKeyName": "UAT key", "expiryDate": "2023-08-08T17:29:21.000Z", "headerName": "CDN-Origin-Auth" }, { "authKeyName": "Customer traffic key", "expiryDate": "2023-08-08T17:29:21.000Z", "headerName": "CDN-Origin-Auth" } ] }, "schema": { "additionalProperties": false, "description": "Auth keys for a specified CDN.", "type": "object", "required": [ "cdnAuthKeys" ], "properties": { "cdnAuthKeys": { "description": "List of auth keys for the specified CDN.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "headerName", "expiryDate", "authKeyName" ], "properties": { "authKeyName": { "description": "Name of the auth key.", "type": "string" }, "expiryDate": { "description": "ISO 8601 expiration date of the key.", "format": "date-time", "type": "string" }, "headerName": { "description": "Header name to use with the key.", "type": "string" } }, "x-akamai": { "file-path": "schemas/CdnAuthKey.yaml" } } } }, "x-akamai": { "file-path": "schemas/CdnAuthKeys.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "The unique identifier Akamai assigned to your [contract](https://techdocs.akamai.com/property-mgr/docs/key-concepts-terms#content-structure), where you've added Cloud Wrapper.", "example": "{{contractId}}", "in": "query", "name": "contractId", "required": true, "schema": { "example": "1-ABCDEF", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-query.yaml" } }, { "description": "The unique identifier Akamai uses for a third-party content delivery network (CDN). [List CDN providers](https://techdocs.akamai.com/cloud-wrapper/reference/get-providers) to get these values.", "example": "{{cdnCode}}", "in": "query", "name": "cdnCode", "required": true, "schema": { "example": "dn002", "type": "string" }, "x-akamai": { "file-path": "parameters/cdnCode-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/multi-cdn/origin-hostnames/{configId}": { "get": { "description": "View a list of origin hostnames for a configuration.", "operationId": "get-origin-hostnames", "summary": "List origin hostnames for a configuration", "tags": [ "Multi-CDN" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-origin-hostnames" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "hostnames": [ { "backup": "backup-hostname.akamaiorigin.net", "cdnName": "Limelight", "locationName": "US East", "primary": "hostname.akamaiorigin.net", "productName": "Obj_Delivery" } ] }, "schema": { "additionalProperties": false, "description": "Origin hostnames associated with a configuration.", "type": "object", "required": [ "hostnames" ], "properties": { "hostnames": { "description": "List of all available CDN providers.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "primary", "backup", "locationName", "productName", "cdnName" ], "properties": { "backup": { "description": "Name of the backup hostname.", "type": "string" }, "cdnName": { "description": "Name of the CDN.", "type": "string" }, "locationName": { "description": "Name of the Cloud Wrapper geographic region.", "type": "string" }, "primary": { "description": "Name of the primary hostname.", "type": "string" }, "productName": { "description": "Name of the Cloud Wrapper product.", "type": "string" } }, "x-akamai": { "file-path": "schemas/CdnHostname.yaml" } } } }, "x-akamai": { "file-path": "schemas/CdnHostnames.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "The unique identifier Akamai assigns to your Cloud Wrapper configuration.", "example": "{{configId}}", "in": "path", "name": "configId", "required": true, "schema": { "example": 12345, "format": "int32", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/configId-path.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/multi-cdn/providers": { "get": { "description": "View a list of CDN providers.", "operationId": "get-providers", "summary": "List CDN providers", "tags": [ "Multi-CDN" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-providers" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "cdnProviders": [ { "cdnCode": "dn002", "cdnName": "Level 3 (Centurylink)" }, { "cdnCode": "dn003", "cdnName": "Limelight" } ] }, "schema": { "additionalProperties": false, "description": "Available CDN providers.", "type": "object", "required": [ "cdnProviders" ], "properties": { "cdnProviders": { "description": "List of all available CDN providers.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "cdnCode", "cdnName" ], "properties": { "cdnCode": { "description": "Unique identifier for the CDN.", "type": "string" }, "cdnName": { "description": "Name of the CDN.", "type": "string" } }, "x-akamai": { "file-path": "schemas/CdnProvider.yaml" } } } }, "x-akamai": { "file-path": "schemas/CdnProviders.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/properties": { "get": { "description": "View a list of properties for delivery products that are eligible to enable Cloud Wrapper.", "operationId": "get-properties", "summary": "List properties", "tags": [ "Properties" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-properties" }, "responses": { "200": { "description": "The response includes a list of eligible properties.", "content": { "application/json": { "example": { "properties": [ { "contractId": "K-0N7RAK71", "groupId": 40010, "propertyId": 123456, "propertyName": "video-on-demand", "type": "MEDIA" }, { "contractId": "C-0N7RAC71", "groupId": 98765, "propertyId": 4567890, "propertyName": "validation-testing", "type": "MEDIA" }, { "contractId": "C-0N7RAC71", "groupId": 98765, "propertyId": 3456789, "propertyName": "production", "type": "WEB" } ] }, "schema": { "additionalProperties": false, "description": "Eligible properties that don't have Cloud Wrapper enabled.", "type": "object", "required": [ "properties" ], "properties": { "properties": { "description": "A list of all eligible properties that don't have Cloud Wrapper enabled.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "groupId", "contractId", "propertyId", "propertyName", "type" ], "properties": { "contractId": { "description": "The unique identifier Akamai assigned to your [contract](https://techdocs.akamai.com/property-mgr/docs/key-concepts-terms#content-structure), where you've added Cloud Wrapper.", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "groupId": { "description": "The unique identifier Akamai assigned to the [group](https://techdocs.akamai.com/property-mgr/docs/key-concepts-terms#content-structure) you used to create the property.", "format": "int64", "maximum": 1000000000, "minimum": 0, "type": "integer" }, "propertyId": { "description": "The unique identifier Akamai assigned to the property you've configured to deliver your media or website content.", "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "propertyName": { "description": "The name of the property you've configured to deliver your media or website content.", "type": "string" }, "type": { "description": "The type of property. `MEDIA` applies to streaming video or downloadable content. `WEB` applies to website content. A `MEDIA` property can't use the same Cloud Wrapper configuration as a `WEB` property.", "type": "string", "enum": [ "MEDIA", "WEB" ] } }, "x-akamai": { "file-path": "schemas/Property.yaml" } } } }, "x-akamai": { "file-path": "schemas/Properties.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "Specify whether the response should contain only unused properties.", "example": "{{unused}}", "in": "query", "name": "unused", "required": false, "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/unused-query.yaml" } }, { "description": "A list of contract IDs with Cloud Wrapper entitlement.", "example": "{{contractIds}}", "in": "query", "name": "contractIds", "required": false, "schema": { "type": "array", "items": { "example": "1-ABCDEF", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" } }, "x-akamai": { "file-path": "parameters/contractIds-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/properties/{propertyId}/origins": { "get": { "description": "View a list of [origin](https://techdocs.akamai.com/property-mgr/reference/latest-origin) servers configured in eligible delivery properties. Response data is pulled from the property as its shown in PAPI. At least one origin server entry is shown at the top-level for the `default` rule. If additional origin servers are set in child-level rules in the same property, they're revealed at a lower level.", "operationId": "get-origins", "summary": "List origins", "tags": [ "Properties" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Cloud Wrapper Configuration API", "url": "https://techdocs.akamai.com/cloud-wrapper/reference/get-origins" }, "responses": { "200": { "description": "The response returns a list of origin servers.", "content": { "application/json": { "example": { "children": [ { "name": "Construct Response for UAT", "behaviors": [ { "hostname": "uat.example.com", "originType": "CUSTOMER" } ] }, { "name": "Centralized Authorization", "behaviors": [] }, { "name": "Edge Server Identification", "behaviors": [ { "hostname": "example.download.akamai.com", "originType": "NET_STORAGE" } ] } ], "default": [ { "hostname": "example.com", "originType": "CUSTOMER" } ] }, "schema": { "additionalProperties": false, "description": "Describes your property's `origin` behaviors and child rules.", "type": "object", "required": [ "default" ], "properties": { "children": { "description": "Represents child rules in a property.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name" ], "properties": { "behaviors": { "description": "This represents the origin behaviors in the rule.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hostname", "originType" ], "properties": { "hostname": { "description": "The origin `hostname` you've set in your property for your [origin server](https://techdocs.akamai.com/property-mgr/reference/latest-origin). Akamai edge servers use this to retrieve your content, to include it in your Cloud Wrapper cache. This only applies if `originType` is set to `CUSTOMER`.", "type": "string" }, "originType": { "description": "The type of [origin server](https://techdocs.akamai.com/property-mgr/reference/latest-origin) you're using to distribute your content. With Cloud Wrapper, you can use `CUSTOMER` for a custom origin server or `NET_STORAGE` to use NetStorage.", "type": "string", "enum": [ "CUSTOMER", "NET_STORAGE" ] } }, "x-akamai": { "file-path": "schemas/Origin.yaml" } } }, "children": { "description": "This represents child-level rules in your property.", "minItems": 0, "type": "array", "items": { "description": "This is a nested property object.", "type": "object", "x-akamai": { "file-path": "schemas/NestedPropertyObject.yaml" } } }, "name": { "description": "The name of the property rule.", "type": "string" } }, "x-akamai": { "file-path": "schemas/PropertiesRuleOrigin.yaml" } } }, "default": { "description": "Represents the `origin` behavior in a default rule.", "minItems": 0, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "hostname", "originType" ], "properties": { "hostname": { "description": "The origin `hostname` you've set in your property for your [origin server](https://techdocs.akamai.com/property-mgr/reference/latest-origin). Akamai edge servers use this to retrieve your content, to include it in your Cloud Wrapper cache. This only applies if `originType` is set to `CUSTOMER`.", "type": "string" }, "originType": { "description": "The type of [origin server](https://techdocs.akamai.com/property-mgr/reference/latest-origin) you're using to distribute your content. With Cloud Wrapper, you can use `CUSTOMER` for a custom origin server or `NET_STORAGE` to use NetStorage.", "type": "string", "enum": [ "CUSTOMER", "NET_STORAGE" ] } }, "x-akamai": { "file-path": "schemas/Origin.yaml" } } } }, "x-akamai": { "file-path": "schemas/PropertyBehaviorsOrigin.yaml" } } } } }, "400": { "description": "[Bad request](https://techdocs.akamai.com/cloud-wrapper/reference/400). You provided bad parameter data or formatted the request body incorrectly.", "content": { "application/problem+json": { "example": { "detail": "Invalid body", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "description": "[Unauthorized](https://techdocs.akamai.com/cloud-wrapper/reference/401). A value in your [authentication credential](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) is invalid or it's expired.", "content": { "application/problem+json": { "example": { "detail": "Unauthorized", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 401, "title": "Unauthorized", "type": "unauthorized" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "description": "[Access forbidden](https://techdocs.akamai.com/cloud-wrapper/reference/403). You lack [permission](https://techdocs.akamai.com/cloud-wrapper/reference/get-started-with-the-cloud-wrapper-configuration-api#set-up-authentication-credentials) for this operation, such as having read-only access.", "content": { "application/problem+json": { "example": { "detail": "Forbidden", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 403, "title": "Forbidden", "type": "forbidden" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "description": "[Not found](https://techdocs.akamai.com/cloud-wrapper/reference/404). You've input the API URL incorrectly or named an asset that doesn't exist.", "content": { "application/problem+json": { "example": { "detail": "Identifier not found", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/404.yaml" } }, "405": { "description": "[Not allowed](https://techdocs.akamai.com/cloud-wrapper/reference/405). You used an unsupported method with this operation. For example, you set the method to PUT for a GET operation.", "content": { "application/problem+json": { "example": { "detail": "Method not allowed", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 405, "title": "Not Allowed", "type": "not_allowed" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/405.yaml" } }, "500": { "description": "[Internal server error](https://techdocs.akamai.com/cloud-wrapper/reference/500). An internal error occurred. Try the request again. If the error continues, contact your account team.", "content": { "application/problem+json": { "example": { "detail": "Internal Server Error", "instance": "12ab3c45-789d-01ef-2gh3-ijk4l56m78no", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": false, "description": "Specific error details for the action.", "type": "object", "required": [ "type", "title", "status", "detail" ], "properties": { "detail": { "description": "Information for the error, including the cause if it's available.", "minLength": 1, "type": "string" }, "instance": { "description": "Identifies each error instance.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code for the error. Possible values: `400`, `401`, `403`, `404`, `405`, `415`, `429`, or `500`.", "type": "integer", "enum": [ 400, 401, 403, 404, 405, 415, 429, 500 ] }, "title": { "description": "The error title.", "minLength": 1, "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } }, "x-akamai": { "file-path": "errors/500.yaml" } } }, "parameters": [ { "description": "The unique identifier Akamai assigned to the property you've configured to deliver your media or website content.", "example": "{{propertyId}}", "in": "path", "name": "propertyId", "required": true, "schema": { "example": 123456, "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/propertyId-path.yaml" } }, { "description": "The unique identifier Akamai assigned to your [contract](https://techdocs.akamai.com/property-mgr/docs/key-concepts-terms#content-structure), where you've added Cloud Wrapper.", "example": "{{contractId}}", "in": "query", "name": "contractId", "required": true, "schema": { "example": "1-ABCDEF", "maxLength": 20, "minLength": 0, "pattern": "^[A-Za-z0-9-_.]*$", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-query.yaml" } }, { "description": "The unique identifier Akamai assigned to the [group](https://techdocs.akamai.com/property-mgr/docs/key-concepts-terms#content-structure) you used to create the property.", "example": "{{groupId}}", "in": "query", "name": "groupId", "required": true, "schema": { "example": 40010, "format": "int64", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/groupId-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } } }, "x-readme": { "samples-languages": [ "curl", "python", "node" ] }, "servers": [ { "url": "https://{hostname}/cloud-wrapper/v1" } ] }