Create New Global Prefix Filter (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/globalprefixfilters

Create a new global prefix filter.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details of the prefix filter to be created

description

Description for the global prefix filter.

filters Filter[]required
List the filters.
Array [
elements string[]
Elements of the filter.
path string[]
Path of the filter.
site object
Site of the filter.
type string
Type of the filter.
]
id string

ID of the global prefix filter.

name stringrequired

Name of the global prefix filters.

Responses

200

Successful Operation

application/json

Schema

Schema

description

Description for the global prefix filter.

filters Filter[]required
List the filters.
Array [
elements string[]
Elements of the filter.
path string[]
Path of the filter.
site object
Site of the filter.
type string
Type of the filter.
]
id string

ID of the global prefix filter.

name stringrequired

Name of the global prefix filters.

Example (from schema)

{
  "filters": [
    {
      "elements": [
        "string"
      ],
      "path": [
        "string"
      ],
      "site": {},
      "type": "string"
    }
  ],
  "id": "string",
  "name": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "SECURITY_FILTER_DUPLICATE_FILTER"
      },
      {
        "code": "SECURITY_FILTER_NAME_REQUIRED"
      },
      {
        "code": "SECURITY_FILTER_INVALID_NAME"
      },
      {
        "code": "SECURITY_FILTER_INVALID_DESCRIPTION"
      },
      {
        "code": "JSON_SCHEMA_MISMATCH"
      }
    ]
  }
}

Loading...