Skip to content
Hyperproof API
/
/
Get a Program

Programs API (1.0)

Provides access to the programs that are part of a Hyperproof organization.

Download OpenAPI description
programs.openapi.json
programs.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/programs/programs.openapi
Hyperproof US
https://api.hyperproof.app/v1/programs
Hyperproof Gov
https://api.hyperproofgov.app/v1/programs
Hyperproof EU
https://api.hyperproof.eu/v1/programs

Get Programs

Request

GET /

Description

Retrieves details of all programs within an organization, including their names, descriptions, statuses, and associated frameworks or controls.

Security
oauth2
Query
statusstring

Filters results by the provided object status

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/programs/programs.openapi/?status=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring

The unique identifier for the program

namestringrequired

The name of the program

Example: "string"
descriptionstring

The description of the program

sectionRootIdstringrequired

The unique identifier for the section root

Example: "string"
programLogoNamestring

The name of the program logo

sourceTemplateIdstring

The unique identifier of the source template

sourceFrameworkIdstring

The unique identifier of the source framework

sourceFrameworkstring

The source framework

primaryContactIdstringrequired

The unique identifier of the primary contact

Example: "string"
workStatusstring(ProgramWorkStatus)required

Program work status

Enum"defining""operating"
overrideHealthboolean

Whether health status is overridden

overrideHealthHealthstring(Health)

Health status

Enum"critical""atRisk""healthy""notAvailable"
overrideHealthByIdstring

The unique identifier of the user who overrode the health status

overrideHealthOnstring

The date when health was overridden (ISO-8601 format)

overrideHealthReasonstring

The reason for overriding health status

selectedBaselinesArray of strings(BaselineType)
Items Enum"low""moderate""high""level1""level2""level3""level4""level5""privacy""security"
baselineEnabledboolean

Whether baseline is enabled for the program

isUpdatingboolean

Whether the program is currently being updated

updateAvailableboolean

Whether an update is available for the program

frameworkVersionMappingobject

Mapping details for framework versions

clonedProgramIdstring

Unique identifier of the cloned program, if applicable

frameworkLicenseNoticestring

License notice for the framework

frameworkVersionMappingIdstring

Unique identifier for the framework version mapping

]
Response
application/json
[
  {
    "name": "string",
    "sectionRootId": "string",
    "primaryContactId": "string",
    "workStatus": "operating"
  }
]

Add Program

Request

POST /

Description

Creates a new program within an organization, defining its name, description, and associated compliance frameworks or objectives.

Security
oauth2
Bodyapplication/json
desriptionstring

The description of the program

namestringrequired

The name of the Program

sectionRootIdstringrequired

The unique identifier for the section root

sourceTemplateIdstring

The unique identifier of the source template

primaryContactIdstring

The unique identifier of the primary contact

workStatusstring(ProgramWorkStatus)required

Program work status

Enum"defining""operating"
selectedBaselinesArray of strings(BaselineType)
Items Enum"low""moderate""high""level1""level2""level3""level4""level5""privacy""security"
jumpstartProgramIdsArray of strings

List of jumpstart program unique identifiers

cloneProgramNamestring

Name of the program to clone, if applicable

frameworkLicenseNoticestring

License notice for the framework

curl -i -X POST \
  https://developer.hyperproof.app/_mock/hyperproof-api/programs/programs.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "desription": "string",
    "name": "string",
    "sectionRootId": "string",
    "sourceTemplateId": "string",
    "primaryContactId": "string",
    "workStatus": "defining",
    "selectedBaselines": [
      "low"
    ],
    "jumpstartProgramIds": [
      "string"
    ],
    "cloneProgramName": "string",
    "frameworkLicenseNotice": "string"
  }'

Responses

Success.

Bodyapplication/json
idstring

The unique identifier for the program

namestringrequired

The name of the program

Example: "string"
descriptionstring

The description of the program

sectionRootIdstringrequired

The unique identifier for the section root

Example: "string"
programLogoNamestring

The name of the program logo

sourceTemplateIdstring

The unique identifier of the source template

sourceFrameworkIdstring

The unique identifier of the source framework

sourceFrameworkstring

The source framework

primaryContactIdstringrequired

The unique identifier of the primary contact

Example: "string"
workStatusstring(ProgramWorkStatus)required

Program work status

Enum"defining""operating"
overrideHealthboolean

Whether health status is overridden

overrideHealthHealthstring(Health)

Health status

Enum"critical""atRisk""healthy""notAvailable"
overrideHealthByIdstring

The unique identifier of the user who overrode the health status

overrideHealthOnstring

The date when health was overridden (ISO-8601 format)

overrideHealthReasonstring

The reason for overriding health status

selectedBaselinesArray of strings(BaselineType)
Items Enum"low""moderate""high""level1""level2""level3""level4""level5""privacy""security"
baselineEnabledboolean

Whether baseline is enabled for the program

isUpdatingboolean

Whether the program is currently being updated

updateAvailableboolean

Whether an update is available for the program

frameworkVersionMappingobject

Mapping details for framework versions

clonedProgramIdstring

Unique identifier of the cloned program, if applicable

frameworkLicenseNoticestring

License notice for the framework

frameworkVersionMappingIdstring

Unique identifier for the framework version mapping

Response
application/json
{
  "name": "string",
  "sectionRootId": "string",
  "primaryContactId": "string",
  "workStatus": "operating"
}

Get a Program

Request

GET /{programId}

Description

Fetches detailed information about a specific Program using its unique ID.

Security
oauth2
Path
programIdstringrequired

Unique ID of the program.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/programs/programs.openapi/{programId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
idstring

The unique identifier for the program

namestringrequired

The name of the program

Example: "string"
descriptionstring

The description of the program

sectionRootIdstringrequired

The unique identifier for the section root

Example: "string"
programLogoNamestring

The name of the program logo

sourceTemplateIdstring

The unique identifier of the source template

sourceFrameworkIdstring

The unique identifier of the source framework

sourceFrameworkstring

The source framework

primaryContactIdstringrequired

The unique identifier of the primary contact

Example: "string"
workStatusstring(ProgramWorkStatus)required

Program work status

Enum"defining""operating"
overrideHealthboolean

Whether health status is overridden

overrideHealthHealthstring(Health)

Health status

Enum"critical""atRisk""healthy""notAvailable"
overrideHealthByIdstring

The unique identifier of the user who overrode the health status

overrideHealthOnstring

The date when health was overridden (ISO-8601 format)

overrideHealthReasonstring

The reason for overriding health status

selectedBaselinesArray of strings(BaselineType)
Items Enum"low""moderate""high""level1""level2""level3""level4""level5""privacy""security"
baselineEnabledboolean

Whether baseline is enabled for the program

isUpdatingboolean

Whether the program is currently being updated

updateAvailableboolean

Whether an update is available for the program

frameworkVersionMappingobject

Mapping details for framework versions

clonedProgramIdstring

Unique identifier of the cloned program, if applicable

frameworkLicenseNoticestring

License notice for the framework

frameworkVersionMappingIdstring

Unique identifier for the framework version mapping

Response
application/json
{
  "name": "string",
  "sectionRootId": "string",
  "primaryContactId": "string",
  "workStatus": "operating"
}

Update a Program

Request

PATCH /{programId}

Description

Updates an existing program identified by its ID, allowing changes to its name, description, or associated compliance details.

Security
oauth2
Path
programIdstringrequired

Unique ID of the program.

Bodyapplication/json
namestring

The name of the Program

descriptionstring

The description of the program

workStatusstring(ProgramWorkStatus)

Program work status

Enum"defining""operating"
overrideHealthboolean

Whether health status is overridden. If true, 'overrideHealthHealth', 'overrideHealthBy', and 'overrideHealthReason' must be populated

overrideHealthHealthstring(Health)

Health status

Enum"critical""atRisk""healthy""notAvailable"
overrideHealthBystring

The unique identifier of the user who overrode the health status

overrideHealthReasonstring

The reason for overriding health status

selectedBaselinesArray of strings(BaselineType)
Items Enum"low""moderate""high""level1""level2""level3""level4""level5""privacy""security"
baselineEnabledboolean

Whether baseline is enabled for the program

frameworkVersionMappingIdstring

The unique identifier for the framework version mapping

removedRequirementIdsArray of strings

List of requirement IDs that have been removed

updatedRequirementIdsArray of strings

List of requirement IDs that have been updated

cloneProgramNamestring

The name of the program to clone, if applicable

isUpdateCompleteboolean

Whether the program update is complete

curl -i -X PATCH \
  'https://developer.hyperproof.app/_mock/hyperproof-api/programs/programs.openapi/{programId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "workStatus": "defining",
    "overrideHealth": true,
    "overrideHealthHealth": "critical",
    "overrideHealthBy": "string",
    "overrideHealthReason": "string",
    "selectedBaselines": [
      "low"
    ],
    "baselineEnabled": true,
    "frameworkVersionMappingId": "string",
    "removedRequirementIds": [
      "string"
    ],
    "updatedRequirementIds": [
      "string"
    ],
    "cloneProgramName": "string",
    "isUpdateComplete": true
  }'

Responses

Success.

Bodyapplication/json
idstring

The unique identifier for the program

namestringrequired

The name of the program

Example: "string"
descriptionstring

The description of the program

sectionRootIdstringrequired

The unique identifier for the section root

Example: "string"
programLogoNamestring

The name of the program logo

sourceTemplateIdstring

The unique identifier of the source template

sourceFrameworkIdstring

The unique identifier of the source framework

sourceFrameworkstring

The source framework

primaryContactIdstringrequired

The unique identifier of the primary contact

Example: "string"
workStatusstring(ProgramWorkStatus)required

Program work status

Enum"defining""operating"
overrideHealthboolean

Whether health status is overridden

overrideHealthHealthstring(Health)

Health status

Enum"critical""atRisk""healthy""notAvailable"
overrideHealthByIdstring

The unique identifier of the user who overrode the health status

overrideHealthOnstring

The date when health was overridden (ISO-8601 format)

overrideHealthReasonstring

The reason for overriding health status

selectedBaselinesArray of strings(BaselineType)
Items Enum"low""moderate""high""level1""level2""level3""level4""level5""privacy""security"
baselineEnabledboolean

Whether baseline is enabled for the program

isUpdatingboolean

Whether the program is currently being updated

updateAvailableboolean

Whether an update is available for the program

frameworkVersionMappingobject

Mapping details for framework versions

clonedProgramIdstring

Unique identifier of the cloned program, if applicable

frameworkLicenseNoticestring

License notice for the framework

frameworkVersionMappingIdstring

Unique identifier for the framework version mapping

Response
application/json
{
  "name": "string",
  "sectionRootId": "string",
  "primaryContactId": "string",
  "workStatus": "operating"
}
® 2026 Hyperproof All Rights Reserved.