Create webpage resource

Create a webpage (URL-type) resource in the Trust Knowledge Base.

POST /knowledge-base/resources/webpages

Create webpage resource

cURL

curl --request POST \
  --url https://api.vanta.com/v1/knowledge-base/resources/webpages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Security overview",
  "url": "https://www.example.com/security",
  "description": "Public security page",
  "customerVisibility": "PUBLIC",
  "includeSubPages": true,
  "isUsedInQuestionnaires": true,
  "tags": [
    {
      "categoryId": "507f1f77bcf86cd799439011",
      "tagId": "507f1f77bcf86cd799439014"
    }
  ],
  "categoryId": "507f1f77bcf86cd799439052"
}
'

200

{
  "id": "507f1f77bcf86cd799439022",
  "type": "URL",
  "title": "Vanta Security Overview",
  "description": "Public-facing overview of Vanta's security posture.",
  "url": "https://www.vanta.com/security",
  "customerVisibility": "PUBLIC",
  "includeSubPages": true,
  "isUsedInQuestionnaires": true,
  "ownerAssignment": {
    "type": "User",
    "id": "507f1f77bcf86cd799439041",
    "displayName": "Alex Rivera"
  },
  "expirationStatus": "CURRENT",
  "expirationDate": "2025-08-01T00:00:00.000Z",
  "lastUpdated": "2024-11-04T13:21:55.000Z",
  "lastVerified": "2024-11-04T13:21:55.000Z",
  "tags": [
    {
      "categoryId": "507f1f77bcf86cd799439011",
      "tagId": "507f1f77bcf86cd799439014"
    }
  ],
  "categoryId": "507f1f77bcf86cd799439052"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

title · string · required

The title of the webpage resource.

Minimum string length: 1

url · string<uri> · required

The URL of the webpage.

description · string

A description for the webpage resource.

ownerAssignment · object

The actor to assign as owner. Currently only type "User" is supported.

Show child attributes

customerVisibility · enum<string>

Customer visibility on the Trust Center.

Available options: PRIVATE, SHAREABLE, REQUEST_ACCESS, PUBLIC

includeSubPages · boolean

Whether to scan sub-pages one level deep alongside the primary URL.

isUsedInQuestionnaires · boolean

Whether the resource should be used for question-answering in Questionnaire Automation.

expirationDate · string

Expiration date in ISO 8601 format.

tags · object[]

Tags to associate with the resource.

Show child attributes

categoryId · string | null

Trust Center category id to associate this resource with. Pass null to keep the resource uncategorized. Only valid when customerVisibility is REQUEST_ACCESS or PUBLIC; other combinations and unknown ids return an InvalidInputError.

Response

200 - application/json

Ok

id · string · required

type · enum<string> · required

Available options: URL

title · string · required

description · string | null · required

url · string · required

customerVisibility · enum<string> | null · required

Available options: PRIVATE, SHAREABLE, REQUEST_ACCESS, PUBLIC, null

includeSubPages · boolean | null · required

isUsedInQuestionnaires · boolean | null · required

ownerAssignment · object · required

Show child attributes

expirationStatus · enum<string> · required

Customer-facing expiration status used by knowledge-base API responses (answer library entries and resources). Derived from the persisted expiresAt field at read time.

Available options: CURRENT, EXPIRED

expirationDate · string | null · required

lastUpdated · string · required

lastVerified · string | null · required

tags · object[] · required

Show child attributes

categoryId · string | null · required

Trust Center category id the resource is currently filed under, or null if uncategorized (or not on the Trust Center, which is the case for PRIVATE / SHAREABLE resources).