Configuration
All operations require authentication.
List VAC policiesProduction
Returns the list of policies within a VAC DDoS protection resource. Every policy applies a profile and a sensitivity level to target IP address prefixes, and carries the configuration requested and the one currently enforced.
Path parameters
Resource name
Query parameters
Filter resources on IAM tags
Headers
Pagination cursor
Pagination size
Response
Checksum of the current configuration, used to detect concurrent changes. Provide it on update to avoid overwriting another change.
Date and time the policy was created
Configuration currently being enforced. Null while the policy is still being created (CREATING).
Details of the last error, set when the status is ERROR
IAM resource metadata
Unique identifier of the policy
Current status of the policy
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is being applied (CREATING, UPDATING or ERROR) it differs from currentState. Once READY it mirrors currentState. Null while the policy is being deleted.
Date and time the policy was last updated
Example uses resourceName = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "enabled": true, "name": "string", "profileId": "string", "profileVersion": 0, "sensitivity": "HIGH", "serviceId": "00000000-0000-0000-0000-000000000000", "targets": [ { "id": "00000000-0000-0000-0000-000000000000", "prefix": { "cidr": "192.0.2.0/24" }, "resolved": [ { "cidr": null, "status": null } ], "type": "PREFIX" } ] }, "errorMessage": "string", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "enabled": true, "name": "string", "profileId": "string", "sensitivity": "HIGH", "targets": [ { "prefix": { "cidr": "192.0.2.0/24" } } ] }, "updatedAt": "2024-01-01T12:00:00Z" }]
Get a VAC policyProduction
Returns a policy with the configuration requested and the one currently enforced, including the status of every protected IP address prefix.
Path parameters
Policy ID
Resource name
Response
Checksum of the current configuration, used to detect concurrent changes. Provide it on update to avoid overwriting another change.
Date and time the policy was created
Configuration currently being enforced. Null while the policy is still being created (CREATING).
Details of the last error, set when the status is ERROR
IAM resource metadata
Unique identifier of the policy
Current status of the policy
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is being applied (CREATING, UPDATING or ERROR) it differs from currentState. Once READY it mirrors currentState. Null while the policy is being deleted.
Date and time the policy was last updated
Example uses policyId = 00000000-0000-0000-0000-000000000000, resourceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "enabled": true, "name": "string", "profileId": "string", "profileVersion": 0, "sensitivity": "HIGH", "serviceId": "00000000-0000-0000-0000-000000000000", "targets": [ { "id": "00000000-0000-0000-0000-000000000000", "prefix": { "cidr": "192.0.2.0/24" }, "resolved": [ { "cidr": "192.0.2.0/24", "status": "ACTIVE" } ], "type": "PREFIX" } ] }, "errorMessage": "string", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "enabled": true, "name": "string", "profileId": "string", "sensitivity": "HIGH", "targets": [ { "prefix": { "cidr": "192.0.2.0/24" } } ] }, "updatedAt": "2024-01-01T12:00:00Z"}
Create a VAC policyProduction
Creates a policy within a VAC DDoS protection resource, applying a profile and a sensitivity level to target IP address prefixes in order to tune detection and mitigation rules. Async call, follow resourceStatus for operation progress. A target whose prefix carries protection settings that were not set via a policy is refused, unless you send force=true to overwrite them.
Path parameters
Resource name
Query parameters
Overwrite the protection settings that were not set via a policy on the targets this request adds. Without it, such a request is refused. The previous settings are lost: you cannot restore them yourself. The force flag is not stored in the policy spec.
Request body (required)
Protection configuration to apply to the policy
Response
Checksum of the current configuration, used to detect concurrent changes. Provide it on update to avoid overwriting another change.
Date and time the policy was created
Configuration currently being enforced. Null while the policy is still being created (CREATING).
Details of the last error, set when the status is ERROR
Unique identifier of the policy
Current status of the policy
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is being applied (CREATING, UPDATING or ERROR) it differs from currentState. Once READY it mirrors currentState. Null while the policy is being deleted.
Date and time the policy was last updated
Example uses resourceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "enabled": true, "name": "string", "profileId": "string", "profileVersion": 0, "sensitivity": "HIGH", "serviceId": "00000000-0000-0000-0000-000000000000", "targets": [ { "id": "00000000-0000-0000-0000-000000000000", "prefix": { "cidr": "192.0.2.0/24" }, "resolved": [ { "cidr": "192.0.2.0/24", "status": "ACTIVE" } ], "type": "PREFIX" } ] }, "errorMessage": "string", "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "enabled": true, "name": "string", "profileId": "string", "sensitivity": "HIGH", "targets": [ { "prefix": { "cidr": "192.0.2.0/24" } } ] }, "updatedAt": "2024-01-01T12:00:00Z"}
Update a VAC policyProduction
Updates the name, enabled state, targets, profile and sensitivity level of a policy. The targets sent fully replace the previous ones: an omitted or empty list of targets removes every target from the policy. Removed target IPs reset their VAC DDoS protection settings to the default state. Send the checksum from the last read. A stale value is rejected. A new target whose prefix carries protection settings that were not set via a policy is refused, unless you send force=true to overwrite them.
Path parameters
Policy ID
Resource name
Query parameters
Overwrite the protection settings that were not set via a policy on the targets this request adds. Without it, such a request is refused. The previous settings are lost: you cannot restore them yourself. The force flag is not stored in the policy spec.
Request body (required)
Checksum returned by the last read, used to detect concurrent changes. A stale value is rejected with HTTP 412.
Protection configuration to apply to the policy
Response
Checksum of the current configuration, used to detect concurrent changes. Provide it on update to avoid overwriting another change.
Date and time the policy was created
Configuration currently being enforced. Null while the policy is still being created (CREATING).
Details of the last error, set when the status is ERROR
Unique identifier of the policy
Current status of the policy
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is being applied (CREATING, UPDATING or ERROR) it differs from currentState. Once READY it mirrors currentState. Null while the policy is being deleted.
Date and time the policy was last updated
Example uses policyId = 00000000-0000-0000-0000-000000000000, resourceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "enabled": true, "name": "string", "profileId": "string", "profileVersion": 0, "sensitivity": "HIGH", "serviceId": "00000000-0000-0000-0000-000000000000", "targets": [ { "id": "00000000-0000-0000-0000-000000000000", "prefix": { "cidr": "192.0.2.0/24" }, "resolved": [ { "cidr": "192.0.2.0/24", "status": "ACTIVE" } ], "type": "PREFIX" } ] }, "errorMessage": "string", "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "enabled": true, "name": "string", "profileId": "string", "sensitivity": "HIGH", "targets": [ { "prefix": { "cidr": "192.0.2.0/24" } } ] }, "updatedAt": "2024-01-01T12:00:00Z"}
Delete a VAC policyProduction
Deletes a policy from a VAC DDoS protection resource. All settings of linked target IP address prefixes return to their default states.
Path parameters
Policy ID
Resource name
Response
Checksum of the current configuration, used to detect concurrent changes. Provide it on update to avoid overwriting another change.
Date and time the policy was created
Configuration currently being enforced. Null while the policy is still being created (CREATING).
Details of the last error, set when the status is ERROR
Unique identifier of the policy
Current status of the policy
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is being applied (CREATING, UPDATING or ERROR) it differs from currentState. Once READY it mirrors currentState. Null while the policy is being deleted.
Date and time the policy was last updated
Example uses policyId = 00000000-0000-0000-0000-000000000000, resourceName = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "enabled": true, "name": "string", "profileId": "string", "profileVersion": 0, "sensitivity": "HIGH", "serviceId": "00000000-0000-0000-0000-000000000000", "targets": [ { "id": "00000000-0000-0000-0000-000000000000", "prefix": { "cidr": "192.0.2.0/24" }, "resolved": [ { "cidr": "192.0.2.0/24", "status": "ACTIVE" } ], "type": "PREFIX" } ] }, "errorMessage": "string", "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "enabled": true, "name": "string", "profileId": "string", "sensitivity": "HIGH", "targets": [ { "prefix": { "cidr": "192.0.2.0/24" } } ] }, "updatedAt": "2024-01-01T12:00:00Z"}