{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Match targets API", "version": "2" }, "items": [ { "info": { "name": "Match targets", "type": "folder" }, "items": [ { "info": { "name": "Get the hostname coverage match targets", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/hostname-coverage/match-targets", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "hostname", "value": "", "type": "query", "description": "Get results by hostname." }, { "name": "accountSwitchKey", "value": "", "type": "query", "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)." } ] }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the API and website match targets that protect a hostname." }, { "info": { "name": "List match targets", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/match-targets", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "", "type": "query", "description": "Specifies the security policy to filter match targets." }, { "name": "includeChildObjectName", "value": "", "type": "query", "description": "Specify whether to return the object name in the payload, true` by default." }, { "name": "accountSwitchKey", "value": "", "type": "query", "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)." } ] }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns match targets defined in the specified security configuration version." }, { "info": { "name": "Create a match target", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/match-targets", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "", "type": "query", "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)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Creates a new Match Target in the specified Configuration Version." }, { "info": { "name": "Modify match target order", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/match-targets/sequence", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "", "type": "query", "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)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Updates the sequence of Match Targets in a configuration version. The `website` and `api` match targets' sequence requires updates from separate requests by passing the `type` attribute in the JSON request." }, { "info": { "name": "Get a match target", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/match-targets/:targetId", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "targetId", "value": "", "type": "path", "description": "A unique identifier for each match target." }, { "name": "includeChildObjectName", "value": "", "type": "query", "description": "Specify whether to return the object name in the payload, true` by default." }, { "name": "accountSwitchKey", "value": "", "type": "query", "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)." } ] }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the specified match target." }, { "info": { "name": "Modify a match target", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/match-targets/:targetId", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "targetId", "value": "", "type": "path", "description": "A unique identifier for each match target." }, { "name": "accountSwitchKey", "value": "", "type": "query", "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)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Updates details about the specified match target." }, { "info": { "name": "Remove a match target", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/match-targets/:targetId", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "targetId", "value": "", "type": "path", "description": "A unique identifier for each match target." }, { "name": "accountSwitchKey", "value": "", "type": "query", "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)." } ] }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Deletes the specified match target." } ] } ], "bundled": true }