Skip to content

VAC DDoS protection

All operations require authentication.

9 operationsv1/ip/{ip}
Agent setup

List mitigation entriesProduction

GET
/1.0/ip/{ip}/mitigation

List mitigation entries. Returns the IP addresses of the block that have a VAC DDoS mitigation entry. Filterable by state or auto-mitigation.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

Query parameters

auto
boolean

Filter the value of auto property (=)

state
MitigationStateEnum

Filter the value of state property (=)

ValuescreationPendingokremovalPending

Response

200ipv4[]successful operation

Example uses ip = 192.0.2.0/24

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigation \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "192.0.2.0"]

List IP mitigation timeoutsProduction

GET
/1.0/ip/{ip}/mitigationProfiles

List IP mitigation timeouts. Returns the IPs of the block with a custom VAC mitigation timeout: how long each one stays in mitigation after an attack ends.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

Response

200ipv4[]successful operation

Example uses ip = 192.0.2.0/24

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigationProfiles \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "192.0.2.0"]

Get a mitigation entryProduction

GET
/1.0/ip/{ip}/mitigation/{ipOnMitigation}

Get a mitigation entry. Returns whether a given IP address of the block is under VAC auto-mitigation, and its state: creationPending, ok or removalPending.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

ipOnMitigation
required
ipv4

IPv4 address (e.g., 192.0.2.0)

Response

200MitigationIpsuccessful operation
auto
read-only
boolean

Set on true if your ip is on auto-mitigation

ipOnMitigation
read-only
ipv4

IPv4 address (e.g., 192.0.2.0)

permanent
boolean

DEPRECATED: this field is kept for backward compatibility of the API, changing its value has no operational impact

state
read-only
MitigationStateEnum

Current state of your ip on mitigation

ValuescreationPendingokremovalPending

Example uses ip = 192.0.2.0/24, ipOnMitigation = 192.0.2.0

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigation/{ipOnMitigation} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "auto": true, "ipOnMitigation": "192.0.2.0", "permanent": true, "state": "creationPending"}

Get an IP mitigation timeoutProduction

GET
/1.0/ip/{ip}/mitigationProfiles/{ipMitigationProfile}

Get an IP mitigation timeout. Returns the VAC mitigation timeout of a given IP address, in minutes, and its state: ok or tasksPending.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

ipMitigationProfile
required
ipv4

IPv4 address (e.g., 192.0.2.0)

Response

200MitigationProfilesuccessful operation
autoMitigationTimeOut
MitigationProfileAutoMitigationTimeOutEnum

Delay to wait before remove ip from auto mitigation after an attack

Values015603601560
ipMitigationProfile
read-only
ipv4

IPv4 address (e.g., 192.0.2.0)

state
read-only
MitigationProfileStateEnum

Current state of your mitigation profile

ValuesoktasksPending

Example uses ip = 192.0.2.0/24, ipMitigationProfile = 192.0.2.0

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigationProfiles/{ipMitigationProfile} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "autoMitigationTimeOut": 0, "ipMitigationProfile": "192.0.2.0", "state": "ok"}

Create a mitigation entryProduction

POST
/1.0/ip/{ip}/mitigation

Create a mitigation entry. Creates a VAC DDoS mitigation entry for an IP address of the block. No longer needed: entries are created automatically during an attack.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

Request body (required)

ipOnMitigation
required
ipv4

IPv4 address (e.g., 192.0.2.0)

Response

200MitigationIpsuccessful operation
auto
read-only
boolean

Set on true if your ip is on auto-mitigation

ipOnMitigation
read-only
ipv4

IPv4 address (e.g., 192.0.2.0)

permanent
boolean

DEPRECATED: this field is kept for backward compatibility of the API, changing its value has no operational impact

state
read-only
MitigationStateEnum

Current state of your ip on mitigation

ValuescreationPendingokremovalPending

Example uses ip = 192.0.2.0/24

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigation \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "auto": true, "ipOnMitigation": "192.0.2.0", "permanent": true, "state": "creationPending"}

Create an IP mitigation timeoutProduction

POST
/1.0/ip/{ip}/mitigationProfiles

Create an IP mitigation timeout. Sets how long, in minutes: 0, 15, 60, 360 or 1560, a given IP address stays in VAC mitigation after an attack ends.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

Request body (required)

autoMitigationTimeOut
required
MitigationProfileAutoMitigationTimeOutEnum

Delay to wait before remove ip from auto mitigation after an attack

Values015603601560
ipMitigationProfile
required
ipv4

IPv4 address (e.g., 192.0.2.0)

Response

200MitigationProfilesuccessful operation
autoMitigationTimeOut
MitigationProfileAutoMitigationTimeOutEnum

Delay to wait before remove ip from auto mitigation after an attack

Values015603601560
ipMitigationProfile
read-only
ipv4

IPv4 address (e.g., 192.0.2.0)

state
read-only
MitigationProfileStateEnum

Current state of your mitigation profile

ValuesoktasksPending

Example uses ip = 192.0.2.0/24

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigationProfiles \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "autoMitigationTimeOut": 0, "ipMitigationProfile": "192.0.2.0", "state": "ok"}

Delete a mitigation entryProduction

DELETE
/1.0/ip/{ip}/mitigation/{ipOnMitigation}

Delete a mitigation entry. Removes a given IP address of the block from VAC mitigation, and returns its mitigation entry with its state.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

ipOnMitigation
required
ipv4

IPv4 address (e.g., 192.0.2.0)

Response

200MitigationIpsuccessful operation
auto
read-only
boolean

Set on true if your ip is on auto-mitigation

ipOnMitigation
read-only
ipv4

IPv4 address (e.g., 192.0.2.0)

permanent
boolean

DEPRECATED: this field is kept for backward compatibility of the API, changing its value has no operational impact

state
read-only
MitigationStateEnum

Current state of your ip on mitigation

ValuescreationPendingokremovalPending

Example uses ip = 192.0.2.0/24, ipOnMitigation = 192.0.2.0

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigation/{ipOnMitigation} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "auto": true, "ipOnMitigation": "192.0.2.0", "permanent": true, "state": "creationPending"}

Delete an IP mitigation timeoutProduction

DELETE
/1.0/ip/{ip}/mitigationProfiles/{ipMitigationProfile}

Delete an IP mitigation timeout. Removes the custom VAC mitigation timeout of a given IP address; the default applies again. The call returns no content.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

ipMitigationProfile
required
ipv4

IPv4 address (e.g., 192.0.2.0)

Response

200—successful operation

Example uses ip = 192.0.2.0/24, ipMitigationProfile = 192.0.2.0

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigationProfiles/{ipMitigationProfile} \
  -H "authorization: Bearer $OVH_TOKEN"

Update an IP mitigation timeoutProduction

PUT
/1.0/ip/{ip}/mitigationProfiles/{ipMitigationProfile}

Update an IP mitigation timeout. Changes the VAC mitigation timeout of a given IP address, the only editable field, to 0, 15, 60, 360 or 1560 minutes.

Path parameters

ip
required
ipBlock

IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)

ipMitigationProfile
required
ipv4

IPv4 address (e.g., 192.0.2.0)

Request body (required)

autoMitigationTimeOut
MitigationProfileAutoMitigationTimeOutEnum

Delay to wait before remove ip from auto mitigation after an attack

Values015603601560
ipMitigationProfile
read-only
ipv4

IPv4 address (e.g., 192.0.2.0)

state
read-only
MitigationProfileStateEnum

Current state of your mitigation profile

ValuesoktasksPending

Response

200—successful operation

Example uses ip = 192.0.2.0/24, ipMitigationProfile = 192.0.2.0

$ curl https://api.eu.ovhcloud.com/1.0/ip/{ip}/mitigationProfiles/{ipMitigationProfile} \
  -H "authorization: Bearer $OVH_TOKEN"