/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"allSources": {
"type": "boolean",
"description": "All Sources"
},
"domain": {
"type": "string",
"description": "The domain value"
},
"note": {
"type": "string",
"description": "The note value"
},
"projectScope": {
"type": "boolean",
"description": "If the specified bypass will apply to all domains for a project."
},
"sourceIp": {
"type": "string",
"description": "Source Ip"
},
"ttl": {
"type": "number",
"description": "Time to live in milliseconds"
}
},
"required": [
"PCID",
"projectId"
]
}
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 | object[] | No | — | The variants of the flag |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"description": {
"type": "string",
"description": "A description of the flag"
},
"environments": {
"type": "object",
"description": "The configuration for the flag in different environments"
},
"kind": {
"description": "The kind of flag",
"enum": [
"boolean",
"string",
"number",
"json"
]
},
"seed": {
"type": "number",
"description": "A random seed to prevent split points in different flags from having the same targets"
},
"state": {
"type": "string",
"description": "The state value",
"enum": [
"active",
"archived"
]
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the variant"
},
"label": {
"type": "string",
"description": "A label for the variant"
},
"description": {
"type": "string",
"description": "A description of the variant"
},
"value": {
"description": "The value value"
}
},
"required": [
"id",
"value"
]
},
"description": "The variants of the flag"
}
},
"required": [
"PCID",
"projectIdOrName",
"environments",
"kind",
"slug"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"createdBy": {
"type": "string",
"description": "The entity who created the segment"
},
"data": {
"type": "object",
"description": "The data of the segment",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object"
},
"description": "The rules value"
},
"include": {
"type": "object",
"description": "Related resources to include"
},
"exclude": {
"type": "object",
"description": "The exclude value"
}
}
},
"description": {
"type": "string",
"description": "The description value"
},
"hint": {
"type": "string",
"description": "The hint value"
},
"label": {
"type": "string",
"description": "The label value"
}
},
"required": [
"PCID",
"projectIdOrName",
"data",
"hint",
"label",
"slug"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"environment": {
"type": "string",
"description": "The environment value"
},
"label": {
"type": "string",
"description": "The label value"
},
"sdkKeyType": {
"type": "string",
"description": "Sdk Key Type",
"enum": [
"server",
"mobile",
"client"
]
}
},
"required": [
"PCID",
"projectIdOrName",
"environment",
"sdkKeyType"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"flagIdOrSlug": {
"type": "string",
"description": "The flag id or name"
},
"ifMatch": {
"type": "string",
"description": "Etag to match, can be used interchangeably with the `if-match` header"
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata in the response"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"flagIdOrSlug"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"segmentIdOrSlug": {
"type": "string",
"description": "The segment slug"
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"segmentIdOrSlug"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"hashKey": {
"type": "string",
"description": "The SDK key hash key to delete"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"hashKey"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project Id"
},
"since": {
"type": "number",
"description": "The since value"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project Id"
},
"limit": {
"type": "number",
"description": "Maximum number of results to return"
},
"sourceIp": {
"type": "string",
"description": "Filter by source IP"
},
"domain": {
"type": "string",
"description": "Filter by domain"
},
"projectScope": {
"type": "boolean",
"description": "Filter by project scoped rules"
},
"offset": {
"type": "string",
"description": "Used for pagination. Retrieves results after the provided id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deploymentId": {
"type": "string",
"description": "Deployment Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"deploymentId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"configVersion": {
"type": "string",
"description": "The deployed configVersion for the firewall configuration"
}
},
"required": [
"PCID",
"projectId",
"configVersion"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project Id"
},
"startTimestamp": {
"type": "number",
"description": "Start Timestamp"
},
"endTimestamp": {
"type": "number",
"description": "End Timestamp"
},
"hosts": {
"type": "string",
"description": "The hosts value"
}
},
"required": [
"PCID",
"projectId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"flagIdOrSlug": {
"type": "string",
"description": "The flag id or name"
},
"ifMatch": {
"type": "string",
"description": "Etag to match, can be used interchangeably with the `if-match` header"
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata in the response"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"flagIdOrSlug"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"segmentIdOrSlug": {
"type": "string",
"description": "The segment slug"
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"segmentIdOrSlug"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "Project Id Or Name"
},
"flagIdOrSlug": {
"type": "string",
"description": "Flag Id Or Slug"
},
"limit": {
"type": "number",
"description": "Maximum number of results to return"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"environment": {
"type": "string",
"description": "Environment to filter by"
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName",
"flagIdOrSlug"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"state": {
"type": "string",
"description": "The state of the flags to retrieve. Defaults to `active`.",
"enum": [
"active",
"archived"
]
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata in the response"
},
"limit": {
"type": "integer",
"description": "Maximum number of flags to return. When not set, all flags are returned."
},
"cursor": {
"type": "string",
"description": "Pagination cursor to continue from."
},
"search": {
"type": "string",
"description": "Search flags by their slug or description. Case-insensitive."
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"projectIdOrName"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Maximum number of settings to return."
},
"cursor": {
"type": "string",
"description": "Pagination cursor to continue from."
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"teamId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"state": {
"type": "string",
"description": "The state of the flags to retrieve. Defaults to `active`.",
"enum": [
"active",
"archived"
]
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata in the response"
},
"limit": {
"type": "integer",
"description": "Maximum number of flags to return."
},
"cursor": {
"type": "string",
"description": "Pagination cursor to continue from."
},
"search": {
"type": "string",
"description": "Search flags by their slug or description. Case-insensitive."
},
"kind": {
"type": "string",
"description": "The kind of flags to retrieve.",
"enum": [
"boolean",
"string",
"number",
"json"
]
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
}
},
"required": [
"PCID",
"teamId"
]
}
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 | object[] | No | — | The ips value |
logHeaders | string[] | No | — | Log Headers |
managedRules | object | No | — | Managed Rules |
rules | object[] | No | — | The rules value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"botIdEnabled": {
"type": "boolean",
"description": "Bot Id Enabled"
},
"crs": {
"type": "object",
"description": "Custom Ruleset",
"properties": {
"sd": {
"type": "object",
"description": "Scanner Detection - Detect and prevent reconnaissance activities from network scanning tools."
},
"ma": {
"type": "object",
"description": "Multipart Attack - Block attempts to bypass security controls using multipart/form-data encoding."
},
"lfi": {
"type": "object",
"description": "Local File Inclusion Attack - Prevent unauthorized access to local files through web applications."
},
"rfi": {
"type": "object",
"description": "Remote File Inclusion Attack - Prohibit unauthorized upload or execution of remote files."
},
"rce": {
"type": "object",
"description": "Remote Execution Attack - Prevent unauthorized execution of remote scripts or commands."
},
"php": {
"type": "object",
"description": "PHP Attack - Safeguard against vulnerability exploits in PHP-based applications."
},
"gen": {
"type": "object",
"description": "Generic Attack - Provide broad protection from various undefined or novel attack vectors."
},
"xss": {
"type": "object",
"description": "XSS Attack - Prevent injection of malicious scripts into trusted webpages."
},
"sqli": {
"type": "object",
"description": "SQL Injection Attack - Prohibit unauthorized use of SQL commands to manipulate databases."
},
"sf": {
"type": "object",
"description": "Session Fixation Attack - Prevent unauthorized takeover of user sessions by enforcing unique session IDs."
},
"java": {
"type": "object",
"description": "Java Attack - Mitigate risks of exploitation targeting Java-based applications or components."
}
}
},
"firewallEnabled": {
"type": "boolean",
"description": "Firewall Enabled"
},
"ips": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"hostname": {
"type": "string",
"description": "The hostname value"
},
"ip": {
"type": "string",
"description": "The ip value"
},
"notes": {
"type": "string",
"description": "The notes value"
},
"action": {
"type": "string",
"enum": [
"deny",
"challenge",
"log",
"bypass"
],
"description": "The action value"
}
},
"required": [
"hostname",
"ip",
"action"
]
},
"description": "The ips value"
},
"logHeaders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Log Headers"
},
"managedRules": {
"type": "object",
"description": "Managed Rules"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "The description value"
},
"active": {
"type": "boolean",
"description": "The active value"
},
"conditionGroup": {
"type": "array",
"items": {
"type": "object",
"properties": {
"conditions": {
"type": "array"
}
}
},
"description": "Condition Group"
},
"action": {
"type": "object",
"description": "The action value"
},
"valid": {
"type": "boolean",
"description": "The valid value"
},
"validationErrors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Validation Errors"
}
},
"required": [
"name",
"active",
"conditionGroup",
"action"
]
},
"description": "The rules value"
}
},
"required": [
"PCID",
"projectId",
"firewallEnabled"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"allSources": {
"type": "boolean",
"description": "All Sources"
},
"domain": {
"type": "string",
"description": "The domain value"
},
"note": {
"type": "string",
"description": "The note value"
},
"projectScope": {
"type": "boolean",
"description": "Project Scope"
},
"sourceIp": {
"type": "string",
"description": "Source Ip"
}
},
"required": [
"PCID",
"projectId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"body": {
"type": "object",
"description": "Request body"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "string",
"description": "Project Id"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"projectId",
"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 | object[] | No | — | The variants of the flag |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"flagIdOrSlug": {
"type": "string",
"description": "The flag id or name"
},
"ifMatch": {
"type": "string",
"description": "Etag to match, can be used interchangeably with the `if-match` header"
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata in the response"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"createdBy": {
"type": "string",
"description": "The user who created this patch"
},
"description": {
"type": "string",
"description": "A description of the flag"
},
"environments": {
"type": "object",
"description": "The configuration for the flag in different environments"
},
"message": {
"type": "string",
"description": "Additional message for this version"
},
"seed": {
"type": "number",
"description": "A random seed to prevent split points in different flags from having the same targets"
},
"state": {
"type": "string",
"description": "The state value",
"enum": [
"active",
"archived"
]
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the variant"
},
"label": {
"type": "string",
"description": "A label for the variant"
},
"description": {
"type": "string",
"description": "A description of the variant"
},
"value": {
"description": "The value value"
}
},
"required": [
"id",
"value"
]
},
"description": "The variants of the flag"
}
},
"required": [
"PCID",
"projectIdOrName",
"flagIdOrSlug"
]
}
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 | object[] | No | — | The operations value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"segmentIdOrSlug": {
"type": "string",
"description": "The segment slug"
},
"withMetadata": {
"type": "boolean",
"description": "Whether to include metadata"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"data": {
"type": "object",
"description": "The data of the segment",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object"
},
"description": "The rules value"
},
"include": {
"type": "object",
"description": "Related resources to include"
},
"exclude": {
"type": "object",
"description": "The exclude value"
}
}
},
"description": {
"type": "string",
"description": "The description value"
},
"hint": {
"type": "string",
"description": "The hint value"
},
"label": {
"type": "string",
"description": "The label value"
},
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"add",
"remove"
],
"description": "The action value"
},
"field": {
"type": "string",
"enum": [
"include",
"exclude"
],
"description": "The field value"
},
"entity": {
"type": "string",
"description": "The entity value"
},
"attribute": {
"type": "string",
"description": "The attribute value"
},
"value": {
"type": "object",
"description": "The value value"
}
},
"required": [
"action",
"field",
"entity",
"attribute",
"value"
]
},
"description": "The operations value"
}
},
"required": [
"PCID",
"projectIdOrName",
"segmentIdOrSlug"
]
}
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 | object[] | No | — | The entities value |
environments | string[] | No | — | The environments to sync |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrName": {
"type": "string",
"description": "The project id or name"
},
"teamId": {
"type": "string",
"description": "The Team identifier to perform the request on behalf of."
},
"slug": {
"type": "string",
"description": "The Team slug to perform the request on behalf of."
},
"enabled": {
"type": "boolean",
"description": "The enabled value"
},
"entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind value"
},
"label": {
"type": "string",
"description": "The label value"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
},
"labels": {
"type": "array"
}
}
},
"description": "The attributes value"
}
},
"required": [
"kind",
"label",
"attributes"
]
},
"description": "The entities value"
},
"environments": {
"type": "array",
"items": {
"type": "string"
},
"description": "The environments to sync"
}
},
"required": [
"PCID",
"projectIdOrName"
]
}

