Public API for managing custom categories
| cursor |
string
Cursor for pagination |
print("Hello World")
{- "totalResults": 0,
- "nextPageCursor": "string",
- "categories": [
- {
- "id": 0,
- "name": "no name",
- "description": "string",
- "policyName": "string"
}
]
}
| name
required
|
string
|
| description |
string
|
| sites |
Array of strings <= 30000 items
List of website URLs and IP addresses |
| policyName |
string
|
| comment |
string
|
{- "name": "string",
- "description": "string",
- "sites": [
- "string"
], - "policyName": "string",
- "comment": "string"
}
{- "transactionId": "00000000-0000-0000-0000-000000000000",
- "status": "pending",
- "data": { },
- "comment": "string"
}
| categoryId
required
|
integer
ID of category to return |
| cursor |
string
Cursor for pagination |
{- "id": 0,
- "name": "no name",
- "description": "string",
- "sites": [
- {
- "totalResults": 0,
- "nextPageCursor": "string",
- "values": [
- "string"
]
}
], - "policyName": "string"
}
| categoryId
required
|
integer
ID of category to return |
Category details
| name
required
|
string
|
| description |
string
|
| sites
required
|
Array of strings <= 30000 items
List of website urls and IP addresses |
| comment |
string
|
{- "name": "string",
- "description": "string",
- "sites": [
- "string"
], - "comment": "string"
}
{- "transactionId": "00000000-0000-0000-0000-000000000000",
- "status": "pending",
- "data": { },
- "comment": "string"
}
| categoryId
required
|
integer
ID of category to return |
| action
required
|
string
Enum: "add" "remove"
Action identifying whether sites are being added or removed |
Site details
| sites
required
|
Array of strings <= 30000 items
List of website urls and IP addresses |
| comment |
string
|
{- "sites": [
- "string"
], - "comment": "string"
}
{- "transactionId": "00000000-0000-0000-0000-000000000000",
- "status": "pending",
- "data": { },
- "comment": "string"
}
| categoryId
required
|
integer
ID of category to return |
{- "transactionId": "00000000-0000-0000-0000-000000000000",
- "status": "pending",
- "data": { },
- "comment": "string"
}
| transactionId
required
|
string
ID of transaction to return |
{- "transactionId": "00000000-0000-0000-0000-000000000000",
- "status": "pending",
- "data": { },
- "comment": "string"
}
Generate a token which could be further used for authorization purpose. For the validation and verification of the generated token it should be passed to platform's /oidc/introspect api.
| X-API-KEY
required
|
string
Example: api-key-string
In this header you will have to pass your api key |
{- "token": "token-string"
}