Logo
Akamai APIs API Documentation

Get a schema for a rule format

GET https://{{host}}/papi/v1/schemas/products/:productId/:ruleFormat

Get the JSON schema for the given product and rule format, which you can use to validate a rule tree object. Note that your rule tree may still fail to activate if you specify features that are optional within the schema for a product but not currently supported on your contract. To validate the set of currently available features you want to activate, run List available behaviors and List available criteria.

 

Body PARAM

Key Datatype Required Description 
accountSwitchKey
string (Optional) 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).



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "properties": { "rules": { "type": "object" } }, "required": [ "rules" ], "type": "object" }



Curl
curl -X GET 'https://host/papi/v1/schemas/products/:productId/:ruleFormat?accountSwitchKey=' -H 'Accept: application/json'

ENDPOINTS