find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/upguard-notifications-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: 'Access information from the CyberRisk platform programmatically using this API.


    You can find or generate an API key to access this API in your CyberRisk Account Settings.

    Please authorize all requests by setting the "Authorization" header to your api key.


    The base url for all public endpoints is https://cyber-risk.upguard.com/api/public'
  title: UpGuard CyberRisk Notifications API
  version: 1.13.2
servers:
- url: https://cyber-risk.upguard.com/api/public
security:
- API key in header: []
tags:
- name: Notifications
paths:
  /notifications:
    get:
      description: 'Returns a list of notifications ordered by their ID. By default, only notifications from the

        last 7 days are returned.


        Required API key permissions: `Admin` (select when creating API key in Account Settings)'
      tags:
      - Notifications
      summary: Get a list of notifications for your organization
      operationId: get_notifications
      responses:
        '200':
          description: List of notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetNotificationsV1ResponsePayloadBody'
        '422':
          description: An invalid parameter was supplied or a mandatory parameter was missing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/endpointError'
        '429':
          description: Too many requests have been made to this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/endpointError'
        '500':
          description: An internal system error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/endpointError'
components:
  schemas:
    endpointError:
      description: Error details coming from an endpoint
      type: object
      properties:
        error:
          description: A description of the error
          type: string
    GetNotificationsV1ResponsePayloadBody:
      type: object
      properties:
        next_page_token:
          description: The token to be used to retrieve the next page of results. The field will be missing if there are no results.
          type: string
        notifications:
          description: The list of notifications.
          type: array
          items:
            $ref: '#/components/schemas/Notification'
    Notification:
      type: object
      properties:
        context:
          description: The context metadata for the notification.
          type: object
          additionalProperties: {}
        description:
          description: Description for the notification.
          type: string
          example: User published a new risk assessment for vendor 'UpGuard'
        notification_id:
          description: The ID of the notification.
          type: string
          example: '20'
        occurred_at:
          description: The time the notification was fired.
          type: string
          format: date-time
          example: '2023-10-13T02:40:00Z'
        type:
          description: The type of the notification.
          type: string
          example: RiskAssessmentPublished
  securitySchemes:
    API_key_in_header:
      type: apiKey
      in: header
      name: Authorization