Organization API: Customer Portal: Shield

The 9 Organization API operations for shield.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/portal/shield/events`	Recent attack events on the customer's IP services, live ones first
GET	`/api/v1/orgs/{org_slug}/portal/shield/status`	The protection on each of your floating IPs and subnets
GET	`/api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/blocked-sources`	The sources refused on this IP, newest first
POST	`/api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/blocked-sources`	Refuse traffic from an address or a CIDR range to this IP only
DELETE	`/api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/blocked-sources/{block_id}`	Remove a block from this IP
GET	`/api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/profile`	Get subject profile
PATCH	`/api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/profile`	Ensure custom profile
POST	`/api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/rules`	Create subject rule
DELETE	`/api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/rules/{rule_id}`	Delete subject rule

Recent attack events on the customer's IP services, live ones first

Section titled Recent attack events on the customer's IP services, live ones first

GET /api/v1/orgs/{org_slug}/portal/shield/events

Recent attack events on the customer's IP services, live ones first.

Parameters

Section titled Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`limit`	query	integer	no	Default: `50`.
`ip_service_id`	query	integer or null	no

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

The protection on each of your floating IPs and subnets

Section titled The protection on each of your floating IPs and subnets

GET /api/v1/orgs/{org_slug}/portal/shield/status

The protection on each of your floating IPs and subnets.

A Cloud Compute instance's IPv6 /64 is listed too, attached to its instance. An address you have not attached stays protected by the platform default.

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

The sources refused on this IP, newest first

Section titled The sources refused on this IP, newest first

GET /api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/blocked-sources

The sources refused on this IP, newest first. Expired blocks are left out.

Parameters

Section titled Parameters

Name	In	Type	Required
`ip_service_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Refuse traffic from an address or a CIDR range to this IP only

Section titled Refuse traffic from an address or a CIDR range to this IP only

POST /api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/blocked-sources

Refuse traffic from an address or a CIDR range to this IP only.

Parameters

Section titled Parameters

Name	In	Type	Required
`ip_service_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`address`	string	yes
`reason`	string or null	no
`expires_minutes`	integer or null	no

Responses

Section titled Responses

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Remove a block from this IP

Section titled Remove a block from this IP

DELETE /api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/blocked-sources/{block_id}

Remove a block from this IP. A block staff added stays (403).

Parameters

Section titled Parameters

Name	In	Type	Required
`ip_service_id`	path	integer	yes
`block_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Get subject profile

Section titled Get subject profile

GET /api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/profile

Parameters

Section titled Parameters

Name	In	Type	Required
`ip_service_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Ensure custom profile

Section titled Ensure custom profile

PATCH /api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/profile

Promote the subject to a customer-editable custom profile (idempotent), then apply any tuning in the body, as /client/shield does.

Parameters

Section titled Parameters

Name	In	Type	Required
`ip_service_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json

Field	Type	Required
`protection_mode`	string or null	no
`default_action`	string or null	no
`established_passthrough`	boolean or null	no
`rate_limits`	RateLimitsPatch or null	no
`rate_limits.per_source_pps`	integer or null	no
`rate_limits.aggregate_pps`	integer or null	no
`rate_limits.syn_pps_per_source`	integer or null	no
`rate_limits.icmp_pps_per_source`	integer or null	no

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Create subject rule

Section titled Create subject rule

POST /api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/rules

Parameters

Section titled Parameters

Name	In	Type	Required
`ip_service_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`name`	string	no
`enabled`	boolean	no
`action`	string	no
`protocol`	integer or null	no
`src_prefix`	string or null	no
`dst_prefix`	string or null	no
`src_port_min`	integer or null	no
`src_port_max`	integer or null	no
`dst_port_min`	integer or null	no
`dst_port_max`	integer or null	no
`tcp_flags_mask`	integer or null	no
`tcp_flags_value`	integer or null	no
`packet_len_min`	integer or null	no
`packet_len_max`	integer or null	no
`ttl_min`	integer or null	no
`ttl_max`	integer or null	no
`icmp_type`	integer or null	no
`icmp_code`	integer or null	no
`rate_limit_pps`	integer or null	no
`notes`	string or null	no

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete subject rule

Section titled Delete subject rule

DELETE /api/v1/orgs/{org_slug}/portal/shield/subjects/{ip_service_id}/rules/{rule_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`ip_service_id`	path	integer	yes
`rule_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.