effectiveTimePeriod

The time period during which the custom rule is active.

API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection

Properties

Name Type Description
endDate string An ISO 8601 timestamp that sets when the rule expires or deactivates.
startDate string An ISO 8601 timestamp that sets when the rule activates.
status string The current status of the rule based on its `startDate` and `endDate`. By default, rules are active for 30 days. When `ACTIVE`, the rule triggers when conditions are met. When `INACTIVE`, the rule doe
View JSON Schema on GitHub

JSON Schema

api-security-effective-time-period-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/json-schema/api-security-effective-time-period-schema.json",
  "title": "effectiveTimePeriod",
  "description": "The time period during which the custom rule is active.",
  "type": "object",
  "properties": {
    "endDate": {
      "description": "An ISO 8601 timestamp that sets when the rule expires or deactivates.",
      "type": "string"
    },
    "startDate": {
      "description": "An ISO 8601 timestamp that sets when the rule activates.",
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "description": "The current status of the rule based on its `startDate` and `endDate`. By default, rules are active for 30 days. When `ACTIVE`, the rule triggers when conditions are met. When `INACTIVE`, the rule doesn't trigger. When `EXPIRING`, the rule still triggers because it's still active until its specified expiration date. When the rule's status is `EXPIRED`, the rule is inactive and doesn't trigger. If your rule expires and you want to use it again, make a PUT request to [Modify a custom rule](https://techdocs.akamai.com/application-security/reference/put-config-custom-rule) with the new dates you'd like the rule to be active.",
      "enum": [
        "active",
        "inactive",
        "expiring",
        "expired"
      ],
      "type": "string"
    }
  },
  "required": [
    "endDate",
    "startDate"
  ],
  "additionalProperties": false
}