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

Put segment

Request

Update a single segment by id.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

segmentIdstringrequired

Id of the segment

Bodyapplication/jsonrequired
segment_namestring

The segment's name

Example: "Panorays"
assetsArray of stringsunique

Segment assets as entered by the user

pocsArray of objects(PocDto)
approvalobject
relationshipsArray of stringsunique
tagsArray of stringsunique
business_impactnumber[ 1 .. 5 ]
business_informationArray of objects(BusinessInformationInput)
portfoliosArray of stringsunique
curl -i -X PUT \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/segments/{segmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "segment_name": "Panorays",
    "assets": [
      "string"
    ],
    "pocs": [
      {
        "email": "user@example.com",
        "name": "string",
        "language": "aa",
        "position": "string",
        "phone": "string"
      }
    ],
    "approval": {
      "status": "PENDING",
      "by": "string",
      "update_ts": "string",
      "reason": "string"
    },
    "relationships": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "business_impact": 1,
    "business_information": [
      {
        "answer": "string",
        "question_id": "string"
      }
    ],
    "portfolios": [
      "string"
    ]
  }'

Responses

Segment updated successfully.

Bodyapplication/json
_idstring
namestring
company_idstring
supplier_idstring
segment_idstring
assetsArray of strings
pocsArray of objects(PocDto)
approvalobject(Approval)
relationshipsobject
tagsArray of strings
business_impactnumber
business_informationArray of objects(BusinessInformationInput)
portfoliosArray of strings
Response
application/json
{
  "_id": "string",
  "name": "string",
  "company_id": "string",
  "supplier_id": "string",
  "segment_id": "string",
  "assets": [
    "string"
  ],
  "pocs": [
    { … }
  ],
  "approval": {
    "status": "PENDING",
    "by": "string",
    "update_ts": "string",
    "reason": "string"
  },
  "relationships": {},
  "tags": [
    "string"
  ],
  "business_impact": 0,
  "business_information": [
    { … }
  ],
  "portfolios": [
    "string"
  ]
}

Get segment by ID

Request

Retrieve a single segment by supplier ID and segment ID.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

segmentIdstringrequired

Id of the segment

curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/segments/{segmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Segment retrieved successfully.

Bodyapplication/json
idstringrequired

Segment unique identifier

segment_namestringrequired

Segment name

assetsArray of stringsrequired

Array of assets (domains, IPs, etc.)

business_informationArray of objects or null(BusinessInformation)required
business_information[].​typestringrequired
Enum"text""date""dropDown""multiSelection""file"
business_impactnumberrequired

Business impact rating (1-5)

portfoliosArray of stringsrequired

Array of portfolio IDs

tagsArray of strings

Array of tag IDs

relationshipsArray of stringsrequired

Relationship types

contactsArray of objects(Contact)
approvalstringrequired

Approval status

evaluation_typestringrequired
Enum"Continuous 360 Evaluation""Continuous Posture Evaluation""Bi-Annual 360 Evaluation""Bi-Annual Posture Evaluation""Smart Questionnaires""Inventory""Monitoring""Assessment""Inventory Plus""None"
latest_assessment_datestring

Latest assessment date in ISO 8601 GMT format

created_bystringrequired

User who created the segment

risknumber or nullrequired

Risk level

combined_scorenumber or nullrequired

Combined risk score

posture_scorenumber or nullrequired

Posture assessment score

questionnaire_overall_scoreobjectrequired

Overall questionnaire score

Response
application/json
{
  "id": "string",
  "segment_name": "string",
  "assets": [
    "string"
  ],
  "business_information": [
    { … }
  ],
  "business_impact": 0,
  "portfolios": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "relationships": [
    "string"
  ],
  "contacts": [
    {}
  ],
  "approval": "string",
  "evaluation_type": "Continuous 360 Evaluation",
  "latest_assessment_date": "string",
  "created_by": "string",
  "risk": 0,
  "combined_score": 0,
  "posture_score": 0,
  "questionnaire_overall_score": {}
}

Delete segment

Request

Delete a single segment by id.

Path
segmentIdstringrequired

Id of the segment

supplierIdstringrequired

Id of the supplier

curl -i -X DELETE \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/segments/{segmentId}'

Responses

Segment deleted successfully

Posture

Operations

Portfolio

Operations

Asset

Operations

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