Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wegalvanize Controls API

A control is a program, policy, routine, or activity that is intended to mitigate a risk. Controls are organized by objectives, and can be associated with one or more risks.The combination of identified risks and corresponding controls defines the Risk Control Matrix. Controls are also known as procedures.> **Note:**Controls located in such resources can be accessed using the API:> * In projects that have an "active" state> * In frameworksLearn more about controls.

Wegalvanize Controls API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Controls. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 8 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.0.2, at version 1.1.0.

Requests are made against a single base URL, {protocol}://{server}/v1.

8 operations 5 paths 10 schemas 2 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.1.0
Base URL
https://apis-us.highbond.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Wegalvanize Controls API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (oauth2) (bearerToken). By default, every request must be authenticated.

  • bearerToken — HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a safe and secure way to access data, while pr…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Controls 8

A control is a program, policy, routine, or activity that is intended to mitigate a risk. Controls are organized by objectives, and can be associated with one or more risks. The c…

GET
/orgs/{org_id}/objectives/{objective_id}/controls
Get controls
getControls 6 params → 200400401403404415
POST
/orgs/{org_id}/objectives/{objective_id}/controls
Create a control
createControl 4 params body → 201400401403404415422
GET
/orgs/{org_id}/controls/{id}
Get a control
getControl 4 params → 200401403404
PATCH
/orgs/{org_id}/controls/{id}
Update a control
updateControl 4 params body → 200400401403404415422
DELETE
/orgs/{org_id}/controls/{id}
Delete a control
deleteControl 2 params → 204401403404422
GET
/orgs/{org_id}/controls
Get all controls in an organization
getOrganizationControls 33 params → 200400401403404415
POST
/orgs/{org_id}/controls/{control_id}/entities
Create control entity link
createControlEntityLink 2 params body → 201400401403404415422
DELETE
/orgs/{org_id}/controls/{control_id}/entities/{id}
Delete control entity link
deleteControlEntityLink 3 params → 204400401403404415422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), GetOrganizationControlsResponse (3 properties), GetControlsResponse (2 properties), GetControlResponse (1 property). Each schema is shown below with its type and property counts.

GetControlsResponse
object
The data associated with the resource.
2 properties 2 required
CreateControlEntityResponse
object
1 property 1 required
Error
object
5 properties 1 required
GetControlResponseWithIncludes
object
The data included in the response.
1 property 1 required
CreateControlEntityRequest
object
The data associated with the resource.
1 property 1 required
GetOrganizationControlsResponse
object
The data associated with the resource.
3 properties 2 required
GetControlResponse
object
The data associated with the resource.
1 property 1 required
Errors
object
1 property
UpdateControlRequest
object
The data associated with the resource.
1 property 1 required
CreateControlRequest
object
The data associated with the resource.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-controls-api-openapi.yml Raw ↑

Other APIs Wegalvanize publishes across the network.

Wegalvanize Actions API
Wegalvanize Activities API
Wegalvanize Analyses API
Wegalvanize Attachments API
Wegalvanize Collaborators API
Wegalvanize Collections API
Wegalvanize Compliance Maps API
Wegalvanize Control performance schedules API
Wegalvanize Control test plans API
Wegalvanize Control tests API
Wegalvanize Custom attributes API
Wegalvanize Entities API