Skip to content

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

Questionnaire

Operations

Get company tests

Request

This endpoint returns the tests of the company.

Query
limitnumber[ 1 .. 200 ]

Number of records to return in the response

Default 200
sortByArray of strings

Name of the field to sort by

Items Enum"name""severity""category""category_text""sub_category""sub_category_text""criterion_text""open_findings_count""closed_findings_count"
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

nameArray of strings

Tests will only contain specified name (all if none)

severityArray of strings

Tests will only contain specified severity (all if none)

Items Enum"info""low""medium""high""critical"
fieldsstring
Enum"name""severity""category""category_text""sub_category""sub_category_text""criterion_text""open_findings_count""closed_findings_count"
curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/tests?limit=200&sortBy=name&sortDirection=ASC&next_token=string&name=string&severity=info&fields=name'

Responses

Tests.

Bodyapplication/json
severitystringrequired
Enum"INFO""LOW""MEDIUM""HIGH""CRITICAL"
categorystringrequired

The key of category

category_textstringrequired

The text of category

sub_categorystringrequired

The key of sub category

sub_category_textstringrequired

The text of sub category

open_findings_countnumberrequired

-1 indicates that no tests were performed

closed_findings_countnumberrequired

-1 indicates that no tests were performed

idstringrequired
namestringrequired
criterion_textstringrequired
Response
application/json
{
  "severity": "INFO",
  "category": "string",
  "category_text": "string",
  "sub_category": "string",
  "sub_category_text": "string",
  "open_findings_count": 0,
  "closed_findings_count": 0,
  "id": "string",
  "name": "string",
  "criterion_text": "string"
}

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