Skip to content
/
Upload files

papi (2)

Panorays Public API

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Support
support@panorays.com
Languages
Servers
Mock server
https://panorays-papi-v2-documentation.redocly.app/_mock/swagger
https://api.panoraysapp.com

Supplier

Use these routes to access and update your suppliers.

Operations

Segment

Operations

Posture

Operations

Portfolio

Operations

Asset

Operations

Finding

Operations

RemediationTasks

Operations

BusinessInformation

Operations

File

Operations

Upload files

Request

Upload one or multiple files to the system. Supports bulk uploads and various file sources. Files are uploaded via multipart/form-data and can be associated with suppliers, segments, or folders for organization.

Security
bearer
Query
typestringrequired

The type/source of the file being uploaded

Enum"businessInformation""connection""inquiry"
Example: type=inquiry
folder_idstring

Optional folder ID to organize uploaded files

Example: folder_id=507f1f77bcf86cd799439011
segment_idstring

Optional segment ID to associate files with a specific segment

Example: segment_id=507f1f77bcf86cd799439011
supplier_idstring

Optional supplier ID to associate files with a specific supplier

Example: supplier_id=507f1f77bcf86cd799439011
display_nameArray of strings

Optional custom display name for the uploaded file(s). For multiple files, provide multiple display_name parameters (e.g., display_name=Name1&display_name=Name2). Order must match file order. Note: The number of files with custom display names may be limited by query string length restrictions.

Bodymultipart/form-datarequired

Files to upload (supports single or multiple files)

filesArray of strings(binary)required
curl -i -X POST \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/files/upload?type=inquiry&folder_id=507f1f77bcf86cd799439011&segment_id=507f1f77bcf86cd799439011&supplier_id=507f1f77bcf86cd799439011&display_name=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F files=string

Responses

Files uploaded successfully. Returns array of uploaded file metadata.

Bodyapplication/jsonArray [
_idstringrequired

The unique identifier of the uploaded file

Example: "507f1f77bcf86cd799439011"
filenamestringrequired

The filename of the uploaded file

Example: "BI_Document_2024.pdf"
]
Response
application/json
[
  {
    "_id": "507f1f77bcf86cd799439011",
    "filename": "BI_Document_2024.pdf"
  }
]

Get file

Request

The endpoint is used to get related files to the company or its suppliers

Security
bearer
Path
fileIdstringrequired
curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/files/{fileId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Found file is returned.

Bodyapplication/json
string(binary)
Response
application/json
"string"

Get supplier's files

Request

The endpoint will retrieve all the files of a specific supplier

Path
supplierIdstringrequired

Id of the supplier

Query
limitnumber[ 1 .. 200 ]

Number of records to return in the response

Default 200
sortBystring

Name of the field to sort by

sortDirectionstring

The direction of the field sort specified by sort_by

Enum"ASC""asc""1""DESC""desc""-1"
next_tokenstring

Token received from a previous request to obtain the next chunk of data

originstring

A list of possible file origins

Enum"businessInformation""connection""inquiry"
fieldsArray of strings

Suppliers will only contain specified fields (all if none)

Items Enum"added_by""filename""insert_ts""origin""type"
curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/files?limit=200&sortBy=string&sortDirection=ASC&next_token=string&origin=businessInformation&fields=added_by'

Responses

All found files.

Bodyapplication/jsonArray [
originstringrequired
Enum"businessInformation""connection""inquiry"
typestringrequired
Enum"jpg""jpeg""png""gif""bmp""accdb""accde""accdr""accdt""aclscript"
filenamestringrequired
idstringrequired
added_bystringrequired
]
Response
application/json
[
  {
    "origin": "businessInformation",
    "type": "jpg",
    "filename": "string",
    "id": "string",
    "added_by": "string"
  }
]

Questionnaire

Operations

RiskInsights

Operations

BusinessSnapshot

Operations

Relationship

Operations

Licenses

Operations

Templates

Operations

Activity Center

Operations

Tags

Tag actions (Create, Delete, Get, Update) apply to company tags only. Tags can’t be updated via the supplier endpoint, as they may link to multiple suppliers. When a company tag is updated/deleted, all associated suppliers are automatically updated — no separate supplier update is needed.

Operations

Factors

Operations

CyberNewsArticles

Operations

DarkWebMentions

Operations

ReEvaluation

Operations

Webhooks Intro

The hook api provides a simple way of registering to events that happen with your suppliers

Getting Started

The following steps will walk you through the process of registering and reacting to webhooks.

  1. Register an API token

If you don’t already have an API token, you can generate one through Panorays platform or contact Panorays Support at support@panorays.com.

  1. Register your app

Before you can start receiving events, register your application with Panorays using the Handshake API call.

  1. Subscribe to relevant events

You will only receive event calls for events you subscribe to using the Subscribe API call.
Note: You can unsubscribe at any time using the Unsubscribe API call.

  1. Start receiving events

You're done! From now on, you will receive notifications for every event you subscribed to.

To learn how to secure your app and ensure you handle events only from Panorays, read about Verifying requests.

Verify Requests

Panorays signs every request with a secret that's unique to your service account, using this secret you can verify that the incoming request arrived from Panorays servers.

Handshake

Operations

Subscription

Operations