Skip to content
Governance Platform

Overview

Governance Studio API 1.0

Section titled “Governance Studio API 1.0”

REST API for managing organizations, projects, policies, controls, indicators, credentials, evidence attachments, and compliance workflows within Governance Studio.

Information

  • OpenAPI version: 2.0

Operations

Section titled “ Operations ”
POST
/api/v1/activity-logs
GET
/api/v1/organizations/{orgId}/activity-logs
GET
/api/v1/projects/{projectId}/activity-logs
GET
/api/v1/attachments/{attachmentId}
GET
/api/v1/attachments/{attachmentId}/download
GET
/api/v1/attachments/{attachmentId}/url
GET
/api/v1/organizations
POST
/api/v1/organizations
GET
/api/v1/organizations/{orgId}
GET
/api/v1/organizations/active/{authId}
GET
/api/v1/organizations/{orgId}/policies
POST
/api/v1/organizations/{orgId}/policies
GET
/api/v1/organizations/{orgId}/policies/{policyId}
POST
/api/v1/policies/convert
POST
/api/v1/policies/export
GET
/api/v1/organizations/{orgId}/policies/{policyId}/controls
GET
/api/v1/organizations/{orgId}/policies/{policyId}/controls/{controlId}
GET
/api/v1/organizations/{orgId}/projects
POST
/api/v1/organizations/{orgId}/projects
GET
/api/v1/projects/{projectId}
PUT
/api/v1/projects/{projectId}/archived
GET
/api/v1/projects/{projectId}/credentials
POST
/api/v1/projects/{projectId}/credentials
GET
/api/v1/projects/{projectId}/credentials/{credentialId}
PUT
/api/v1/projects/{projectId}/credentials/{credentialId}
DELETE
/api/v1/projects/{projectId}/credentials/{credentialId}
POST
/api/v1/projects/{projectId}/credentials/validate
POST
/api/v1/projects/{projectId}/demo-data/confirm
POST
/api/v1/projects/{projectId}/demo-data/preview
DELETE
/api/v1/projects/{projectId}/demo-data/sessions/{sessionId}
GET
/api/v1/projects/{projectId}/policies
POST
/api/v1/projects/{projectId}/policies/{policyId}
GET
/api/v1/projects/{projectId}/policies/{projectPolicyId}
PUT
/api/v1/projects/{projectId}/policies/{projectPolicyId}
PUT
/api/v1/projects/{projectId}/policies/{projectPolicyId}/archived
GET
/api/v1/projects/{projectId}/policies/{projectPolicyId}/certificates
POST
/api/v1/projects/{projectId}/policies/{projectPolicyId}/certificates
PUT
/api/v1/projects/{projectId}/policies/{projectPolicyId}/certificates/{certificateId}/revoke
GET
/api/v1/projects/{projectId}/policies/{projectPolicyId}/controls/{controlId}
GET
/api/v1/projects/{projectId}/policies/{projectPolicyId}/details
GET
/api/v1/projects/{projectId}/policies/baseline
POST
/api/v1/projects/{projectId}/policies/manifest
POST
/api/v1/projects/{projectId}/policies/report
POST
/api/v1/projects/{projectId}/policies/{projectPolicyId}/controls/{projectPolicyControlId}/declarations
POST
/api/v1/projects/{projectId}/policies/{projectPolicyId}/controls/{projectPolicyControlId}/declarations/with-file
POST
/api/v1/projects/{projectId}/policies/{projectPolicyId}/controls/{projectPolicyControlId}/reviews
POST
/api/v1/projects/{projectId}/policies/{projectPolicyId}/controls/{projectPolicyControlId}/reviews/with-file
GET
/api/v2/evaluations
GET
/api/v2/evaluations/{id}
POST
/api/v2/events/ingest
GET
/api/v2/projects/{projectId}/indicator-applications
GET
/api/v2/projects/{projectId}/indicator-applications/{applicationId}
DELETE
/api/v2/projects/{projectId}/indicator-applications/{applicationId}
POST
/api/v2/projects/{projectId}/indicator-applications/{applicationId}/disable
POST
/api/v2/projects/{projectId}/indicator-applications/{applicationId}/enable
GET
/api/v2/projects/{projectId}/indicators
POST
/api/v2/projects/{projectId}/indicators
GET
/api/v2/projects/{projectId}/indicators/{indicatorId}
DELETE
/api/v2/projects/{projectId}/indicators/{indicatorId}
GET
/api/v2/projects/{projectId}/indicators/{indicatorId}/applications
POST
/api/v2/projects/{projectId}/indicators/{indicatorId}/applications
GET
/health
GET
/health/auth
GET
/health/ready

Authentication

Section titled “ Authentication ”

ApiKeyAuth

Section titled “ApiKeyAuth ”

Type “Bearer” followed by a space and API key.

Security scheme type: apiKey

Header parameter name: Authorization

BearerAuth

Section titled “BearerAuth ”

Type “Bearer” followed by a space and JWT token.

Security scheme type: apiKey

Header parameter name: Authorization