Restricted file types

The following file types are restricted from use in the API import process. You can also add additional file types that you want to restrict from the import process. The ability to restrict additional file types provides flexibility and increased security based on your business needs and security standards. If the application encounters any of the restricted file types, it generates an error code and a corresponding error message.

• .exe
• .com
• .bat
• .cmd
• .msi
• .vb or .vbs
• .scf
• .scr
• .pif
• .zip
• .rar

To add additional file types to the restricted list:

1. Log in to the Pega Knowledge authoring portal.
2. On the left pane, click Configuration, and then select Article API configuration.
3. In the Restricted file type field, enter the file type you want to restrict, and then click Add.
4. Click Save.

Method: POST

Sample endpoint URL

https://<DomainName>/prweb/api/PegaKMREST/articles/KMCreateArticle

Request Header

The Request header should contain Content-Type as a multipart/form-data and boundary that you define with the other data.

Example:

Content-Type: multipart/form-data; boundary=--------abc123

Query parameters

* Mandatory parameters

Request body

If the content type is set to "Authored", the Request body should contain text for the article body. Because the system sends the request as multipart/form-data, the request body can contain data in the key value format, as shown in the following example:

Example:

Content-Disposition: form-data; name=”Body”

Request parameters

Sample request body

The following sample request body contains text for the article body along with an image file in key value format.

File: 0.jpg
Body: this is text for article body
The Http code for the above request body will be as---------------------------------360742209208194055953283
Content-Disposition: form-data; name="file"; filename="0.jpg"
<0.jpg>
--------------------------------------------36-742209208194055953283
Content-Disposition: form-data; name="Body"
this is text for article body

In the above sample code, ----------------------------360742209208194055953283 acts as boundary. File is the key and “0.jpg” is the value. Body is the key and "this is text for article body" is the value.

POST /prweb/PRRRestService/PegaKMREST/articles/KMCreateArticle?
ArticleTitle=This%20is%20rest%20API%20Demo&ArticleAbstract=This%20is%
20rest%20API%20Demo&ContentType=Authored&CategoryIDs=TAX-
1&ContentURL=&IsInternalContent=false&Tags=api&AticleLanguage=en

HTTP/1.1Authorization: Bearer
e3YxfWE3NTNjZTQ0NGM3ODEzMTg2NmFiOTNkNmE3MGE4NTc=

User-Agent: PostmanRuntime/7.26.3Accept: */*Cache-Control: no-
cachePostman-Token: 16347ab3-1e9c-4d1d-aef7-1b654c2fc456Host:
lab5203.lab.pega.comAccept-Encodng: gzip, deflate, brConnection: keep-alive

Content-Type: multipart/form-data; boundary=------------------------------
-544197066538882863805869

Content-Length: 38817 -----------------------54197066538882863805869

Content-Disposition: form-data; name="file";filename="0.jpg"

<0.jpg>
------------------------544197066538882863805869
Content-Disposition: form-data; name="Body"

this is text for article body
----------------------544197066538882863805869

Sample request

{
 
"ArticleAbstract": "",
  "ArticleTitle": "",
  "CategoryIds": "",
  "ContentSourceAuthored": "",
  "ContentSourceURL": "",
  "ContentType": "",
  "KMArticleLanguage": "",
  "KMContentCreationSource": "",
  "tagsList": ""

}

Sample response

{
  "ArticleAbstract": "This is a rest API Demo",
  "ArticleTitle": "This is a rest API Demo",
  "CategoryIds": "TAX-1",
  "ContentSourceAuthored": "this is text for article body",
  "ContentSourceURL": "",
  "ContentType": "Authored",
  "KMArticleLanguage": "en",
  "KMContentCreationSource": "API",
  "pyID": "KC-7006",
  "tagsList": "api"

}

Configuring rate limits to mitigate Denial of Service attachments

You can set the number of articles that can be created via the API for a specific amount of time by configuring the Allowed articles volume and the Time (in minutes) to determine rate limit settings. Note that the combination of the values of these two fields determines the threshold for the rate limit. For example, if you select 1 for time and 1000 for article volume the system will process 1000 article creation requests per minute. If the system receives more than 1000 requests, it generates the following error message: "Rejecting request as number of requests exceeded threshold".

To configure the rate limit:

1. Log in to the Pega Knowledge authoring portal.
2. In the left pane, click Configuration, and then select Article API Configuration.
3. In the Time (in minutes) to determine rate limit field, select the time (in minutes).
4. In the Allowed articles volume field, select the number of articles that the system can create in the time specified.
5. Click Save.

Request validation errors

Attachment validation errors

Configuring the virus scan stub

When you configure the CallVirusCheck utility stub, the system calls the utility before uploading any files. If the utility finds a virus, it will not save the file to the database. The system calls the utility for every attachment that is sent using REST API or that is uploaded manually. To handle any viruses that the utility finds, set the VirusCheckStatus parameter in the CallVirusCheck utility with the prefix “Virus”+Message.