Skip to Content

Documentation

v2023.5.0 Release Notes

Updated on:

These are Release Notes for v2023.5.0 of Risk Cloud API v2, released on May 8th, 2023.

Risk Cloud API v2 is a collection of new API-first and RESTful API endpoints to streamline the creation of custom integrations with the Risk Cloud.

These endpoints are currently in open alpha, meaning that backwards compatibility is not guaranteed and breaking changes are to be expected as the endpoints are finalized. The full release of these new v2 endpoints is anticipated for late 2023.

Risk Cloud API v2 Resources

Authentication

POST/api/v1/account/token

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*

Application

GET/api/v2/applications

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
POST/api/v2/applications

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*

Changed content type : application/json

  • Changed property type (string)
    Added enum values:
    • CONTROLS_COMPLIANCE
    • CYBER_RISK_MANAGEMENT
    • DATA_PRIVACY_MANAGEMENT
    • ESG
    • INTERNAL_AUDIT_MANAGEMENT
    • OPERATIONAL_RESILIENCY
    • POLICY_MANAGEMENT
    • REPOSITORY
GET/api/v2/applications/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
DELETE/api/v2/applications/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
PATCH/api/v2/applications/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*

Changed content type : application/json

  • Added property restrict-build-access (boolean)
  • Deleted property restrictBuildAccess (boolean)
  • Changed property type (string)
    Added enum values:
    • CONTROLS_COMPLIANCE
    • CYBER_RISK_MANAGEMENT
    • DATA_PRIVACY_MANAGEMENT
    • ESG
    • INTERNAL_AUDIT_MANAGEMENT
    • OPERATIONAL_RESILIENCY
    • POLICY_MANAGEMENT
    • REPOSITORY

Workflow

GET/api/v2/workflows

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
  • Added: application-id in query
  • Added: include-jira-workflows in query
  • Deleted: applicationId in query
  • Deleted: includeJiraWorkflows in query
POST/api/v2/workflows

Changed response : 200 OK

  • New content type : application/json

  • Deleted content type : */*

Changed content type : application/json

New required properties:

  • application-id
  • record-prefix

New optional properties:

  • applicationId
  • recordPrefix
  • Added property record-prefix (string)
  • Added property application-id (string)
  • Deleted property recordPrefix (string)
  • Deleted property applicationId (string)
GET/api/v2/workflows/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
DELETE/api/v2/workflows/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
PATCH/api/v2/workflows/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*

Changed content type : application/json

  • Added property record-prefix (string)
  • Deleted property recordPrefix (string)

Workflow Map

GET/api/v2/workflow-maps

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
  • Added: workflow-id in query
  • Deleted: workflowId in query
POST/api/v2/workflow-maps

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
GET/api/v2/workflow-maps/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
DELETE/api/v2/workflow-maps/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*
PATCH/api/v2/workflow-maps/{id}

Changed response : 200 OK

  • New content type : application/json
  • Deleted content type : */*