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

Get company assets

Request

The endpoint is used to get all company assets.

Security
bearer
Query
limitnumber[ 1 .. 200 ]

Number of records to return in the response

Default 200
sortBystring

Name of the field to sort by

Enum"name""type""insert_ts"
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

fieldsArray of strings

Asset will only contain specified fields (all if none)

Items Enum"name""insert_ts""type""is_up""location""domains""ips""asset_lifecycle""dispute_status""id"
nameArray of strings

Name of the asset

typeArray of strings

Asset type

Items Enum"DOMAIN""SUBDOMAIN""IP""IP_RANGE""domain""subdomain""ip""ip_range"
is_upboolean

Is the asset active or not

segmentsArray of strings

Ids of the segments

curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/assets?limit=200&sortBy=name&sortDirection=ASC&next_token=string&fields=name&name=string&type=DOMAIN&is_up=true&segments=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

All found assets

Bodyapplication/jsonArray [
typestringrequired
Enum"DOMAIN""SUBDOMAIN""IP""IP_RANGE"
is_upbooleanrequired

Is the asset active or not

locationstringrequired

The asset location, two letter country code

domainsArray of strings or null

List of domains corresponding with the asset. Only for assets of type IP

ipsArray of strings or null

List of ips corresponding with the asset. Only for assets of type DOMAIN or SUBDOMAIN

asset_lifecyclestringrequired

Assets Lifecycle

dispute_statusstringrequired

Dispute status

discovery_originstringrequired

Asset discovery origin

namestringrequired
insert_tsstringrequired
]
Response
application/json
[
  {
    "type": "DOMAIN",
    "is_up": true,
    "location": "string",
    "domains": [ … ],
    "ips": [ … ],
    "asset_lifecycle": "string",
    "dispute_status": "string",
    "discovery_origin": "string",
    "name": "string",
    "insert_ts": "string"
  }
]

Create company assets

Request

The endpoint is used to create company assets.

Bodyapplication/jsonrequired
assetsArray of stringsrequired

assets by name, e.g., "127.0.0.1", "panorays.com"

Example: ["127.0.0.10","panorays.com"]
curl -i -X POST \
  https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/assets \
  -H 'Content-Type: application/json' \
  -d '{
    "assets": [
      "127.0.0.10",
      "panorays.com"
    ]
  }'

Responses

All created assets

Bodyapplication/jsonArray [
typestringrequired
Enum"DOMAIN""SUBDOMAIN""IP""IP_RANGE"
is_upbooleanrequired

Is the asset active or not

locationstringrequired

The asset location, two letter country code

domainsArray of strings or null

List of domains corresponding with the asset. Only for assets of type IP

ipsArray of strings or null

List of ips corresponding with the asset. Only for assets of type DOMAIN or SUBDOMAIN

asset_lifecyclestringrequired

Assets Lifecycle

dispute_statusstringrequired

Dispute status

discovery_originstringrequired

Asset discovery origin

namestringrequired
insert_tsstringrequired
]
Response
application/json
[
  {
    "type": "DOMAIN",
    "is_up": true,
    "location": "string",
    "domains": [ … ],
    "ips": [ … ],
    "asset_lifecycle": "string",
    "dispute_status": "string",
    "discovery_origin": "string",
    "name": "string",
    "insert_ts": "string"
  }
]

Finding

Operations

RemediationTasks

Operations

BusinessInformation

Operations

File

Operations

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