Update a property

put

https://{hostname}/sandbox-api/v1/sandboxes/{sandboxId}/properties/{sandboxPropertyId}

Update the requestHostnames of the sandbox property. Your sandbox can support many hostnames for testing purposes.

Path Params

sandboxPropertyId

string

required

Unique identifier for the property within a sandbox.

sandboxId

string

required

Unique identifier for the sandbox.

Query Params

access

string

enum

Defaults to USER

Enum The access level of the request. Either the default USER value to perform the request for the sandboxes that you can access, or ACCOUNT to perform the request for all sandboxes within the account.

Allowed:

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Each sandbox contains at least one property. The property configuration describes the origin location and content-handling specifications.

_links

object

HAL-formatted hypermedia links relating to the property. See Hypermedia for more information.

additionalRequestHostnamesInProperty

array of strings

length ≥ 1

Hostnames found in the property configuration not specified in the Create a sandbox request.

additionalRequestHostnamesInProperty

cpcode

number

Unique identifier used for reporting traffic served. The Sandbox API tries to use the same CP code for all traffic within a particular Control Center access group.

editedRuleBehaviors

array of strings

Behaviors in the rule tree that were modified for use in the Sandbox.

editedRuleBehaviors

filteredRuleBehaviors

array of strings

Behaviors in the rule tree that were removed because they aren't supported by Sandbox.

filteredRuleBehaviors

productId

string

The Akamai product assigned to the property, as defined in Property Manager.

propertyId

string

The identifier for the property from which the sandbox was created.

requestHostnames

array of strings

required

length ≥ 1

Customer-specific hostnames included in the property configuration. You can use them to make requests and test changes in the sandbox. The Sandbox API defaults to the hostnames configured in the property unless you specify alternates.

requestHostnames*

ruleFormat

string

The Property Manager rule format used within the property.

sandboxPropertyId

string

Unique identifier for a property within the sandbox.

validationStatus

string

The validation status for the property. If the status is OK the sandbox can serve traffic. If the status is ERROR you can find the statusReason in the sandbox response object.

validationWarnings

array

Warnings from validating the rule tree when a sandbox exists or a property is added. For details, refer to Errors.

validationWarnings

Response

204

The request was successfully processed.

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!