/vercel-security | Type: Application | PCID required: Yes
Tools
vercel_security_add_bypass_ip
Create System Bypass Rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
allSources | boolean | No | — | All Sources |
domain | string | No | — | The domain value |
note | string | No | — | The note value |
projectScope | boolean | No | — | If the specified bypass will apply to all domains for a project. |
sourceIp | string | No | — | Source Ip |
ttl | number | No | — | Time to live in milliseconds |
vercel_security_create_flag
Create a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | Yes | — | The Team slug to perform the request on behalf of. |
description | string | No | — | A description of the flag |
environments | object | Yes | — | The configuration for the flag in different environments |
kind | object | Yes | — | The kind of flag |
seed | number | No | — | A random seed to prevent split points in different flags from having the same targets |
state | string | No | — | The state value |
variants | any[] | No | — | The variants of the flag |
vercel_security_create_flag_segment
Create a segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | Yes | — | The Team slug to perform the request on behalf of. |
createdBy | string | No | — | The entity who created the segment |
data | object | Yes | — | The data of the segment |
description | string | No | — | The description value |
hint | string | Yes | — | The hint value |
label | string | Yes | — | The label value |
vercel_security_create_sdk_key
Create an SDK key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
environment | string | Yes | — | The environment value |
label | string | No | — | The label value |
sdkKeyType | string | Yes | — | Sdk Key Type |
vercel_security_delete_flag
Delete a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
flagIdOrSlug | string | Yes | — | The flag id or name |
ifMatch | string | No | — | Etag to match, can be used interchangeably with the if-match header |
withMetadata | boolean | No | — | Whether to include metadata in the response |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_delete_flag_segment
Delete a segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
segmentIdOrSlug | string | Yes | — | The segment slug |
withMetadata | boolean | No | — | Whether to include metadata |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_delete_sdk_key
Delete an SDK key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
hashKey | string | Yes | — | The SDK key hash key to delete |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_get_active_attack_status
Read active attack data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
since | number | No | — | The since value |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_get_bypass_ip
Read System Bypass Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
limit | number | No | — | Maximum number of results to return |
sourceIp | string | No | — | Filter by source IP |
domain | string | No | — | Filter by domain |
projectScope | boolean | No | — | Filter by project scoped rules |
offset | string | No | — | Used for pagination. Retrieves results after the provided id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_get_deployment_feature_flags
Retrieve the feature flags of a deployment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deploymentId | string | Yes | — | Deployment Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_get_firewall_config
Read Firewall Configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
configVersion | string | Yes | — | The deployed configVersion for the firewall configuration |
vercel_security_get_firewall_events
Read Firewall Actions by Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
startTimestamp | number | No | — | Start Timestamp |
endTimestamp | number | No | — | End Timestamp |
hosts | string | No | — | The hosts value |
vercel_security_get_flag
Get a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
flagIdOrSlug | string | Yes | — | The flag id or name |
ifMatch | string | No | — | Etag to match, can be used interchangeably with the if-match header |
withMetadata | boolean | No | — | Whether to include metadata in the response |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_get_flag_segment
Get a segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
segmentIdOrSlug | string | Yes | — | The segment slug |
withMetadata | boolean | No | — | Whether to include metadata |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_get_flag_settings
Get project flag settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_get_sdk_keys
Get all SDK keys Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_list_flag_segments
List segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
withMetadata | boolean | No | — | Whether to include metadata |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_list_flag_versions
List flag versions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | Project Id Or Name |
flagIdOrSlug | string | Yes | — | Flag Id Or Slug |
limit | number | No | — | Maximum number of results to return |
cursor | string | No | — | Pagination cursor |
environment | string | No | — | Environment to filter by |
withMetadata | boolean | No | — | Whether to include metadata |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_list_flags
List flags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
state | string | No | — | The state of the flags to retrieve. Defaults to active. |
withMetadata | boolean | No | — | Whether to include metadata in the response |
limit | integer | No | — | Maximum number of flags to return. When not set, all flags are returned. |
cursor | string | No | — | Pagination cursor to continue from. |
search | string | No | — | Search flags by their slug or description. Case-insensitive. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_list_team_flag_settings
List team project flag settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of settings to return. |
cursor | string | No | — | Pagination cursor to continue from. |
teamId | string | Yes | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_list_team_flags
List all flags for a team Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
state | string | No | — | The state of the flags to retrieve. Defaults to active. |
withMetadata | boolean | No | — | Whether to include metadata in the response |
limit | integer | No | — | Maximum number of flags to return. |
cursor | string | No | — | Pagination cursor to continue from. |
search | string | No | — | Search flags by their slug or description. Case-insensitive. |
kind | string | No | — | The kind of flags to retrieve. |
teamId | string | Yes | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_security_put_firewall_config
Put Firewall Configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
botIdEnabled | boolean | No | — | Bot Id Enabled |
crs | object | No | — | Custom Ruleset |
firewallEnabled | boolean | Yes | — | Firewall Enabled |
ips | any[] | No | — | The ips value |
logHeaders | any[] | No | — | Log Headers |
managedRules | object | No | — | Managed Rules |
rules | any[] | No | — | The rules value |
vercel_security_remove_bypass_ip
Remove System Bypass Rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
allSources | boolean | No | — | All Sources |
domain | string | No | — | The domain value |
note | string | No | — | The note value |
projectScope | boolean | No | — | Project Scope |
sourceIp | string | No | — | Source Ip |
vercel_security_update_attack_challenge_mode
Update Attack Challenge mode Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
body | object | Yes | — | Request body |
vercel_security_update_firewall_config
Update Firewall Configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | Project Id |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
body | object | Yes | — | Request body |
vercel_security_update_flag
Update a flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
flagIdOrSlug | string | Yes | — | The flag id or name |
ifMatch | string | No | — | Etag to match, can be used interchangeably with the if-match header |
withMetadata | boolean | No | — | Whether to include metadata in the response |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
createdBy | string | No | — | The user who created this patch |
description | string | No | — | A description of the flag |
environments | object | No | — | The configuration for the flag in different environments |
message | string | No | — | Additional message for this version |
seed | number | No | — | A random seed to prevent split points in different flags from having the same targets |
state | string | No | — | The state value |
variants | any[] | No | — | The variants of the flag |
vercel_security_update_flag_segment
Update a segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
segmentIdOrSlug | string | Yes | — | The segment slug |
withMetadata | boolean | No | — | Whether to include metadata |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
data | object | No | — | The data of the segment |
description | string | No | — | The description value |
hint | string | No | — | The hint value |
label | string | No | — | The label value |
operations | any[] | No | — | The operations value |
vercel_security_update_flag_settings
Update project flag settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectIdOrName | string | Yes | — | The project id or name |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
enabled | boolean | No | — | The enabled value |
entities | any[] | No | — | The entities value |
environments | any[] | No | — | The environments to sync |

