{ "opencollection": "1.0.0", "info": { "name": "Akamai: Application Security Activation history Match targets API", "version": "v1" }, "items": [ { "info": { "name": "Match targets", "type": "folder" }, "items": [ { "info": { "name": "Akamai API Security Get the Hostname Coverage Match Targets", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/hostname-coverage/match-targets", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "hostname", "value": "{{hostname}}", "type": "query", "description": "Get results by hostname." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "List the API and website match targets that protect a hostname. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module." }, { "info": { "name": "Akamai API Security List Match Targets", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "query", "description": "Specifies the security policy to filter match targets." }, { "name": "includeChildObjectName", "value": "{{includeChildObjectName}}", "type": "query", "description": "Specify whether to return the object name in the payload, true` by default." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Returns match targets defined in the specified security configuration version. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module." }, { "info": { "name": "Akamai API Security Create a Match Target", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Creates a new Match Target in the specified Configuration Version. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module." }, { "info": { "name": "Akamai API Security Modify Match Target Order", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets/sequence", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "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. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module." }, { "info": { "name": "Akamai API Security Get a Match Target", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets/:targetId", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "targetId", "value": "{{targetId}}", "type": "path", "description": "A unique identifier for each match target." }, { "name": "includeChildObjectName", "value": "{{includeChildObjectName}}", "type": "query", "description": "Specify whether to return the object name in the payload, true` by default." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Returns the specified match target. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module." }, { "info": { "name": "Akamai API Security Modify a Match Target", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets/:targetId", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "targetId", "value": "{{targetId}}", "type": "path", "description": "A unique identifier for each match target." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Updates details about the specified match target. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module." }, { "info": { "name": "Akamai API Security Remove a Match Target", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets/:targetId", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "targetId", "value": "{{targetId}}", "type": "path", "description": "A unique identifier for each match target." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Deletes the specified match target. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module." } ] } ], "bundled": true }