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 Projects API

A project is a management system that allows you to define objectives, risks, and controls, perform tests, and compile information for reporting purposes. Projects may alsobe known as audits, compliance assessments, risk assessments, or another customized term.Each project has a default system classification, called a "state". A project can have one of the following states:* `"active"`— projects that are currently in progress* `"archive"`— projects that are inactive and have been moved to the Project Library* `"delete"`— previously deleted projects that are stored in the Project Library for 30 days, and then permanently deleted automatically after 30 daysProjects in a `"framework"` state cannot be accessed using the API.Learn more about projects.

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

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

This API exposes 7 operations across 4 paths, and defines 9 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.

7 operations 4 paths 9 schemas 2 DELETE2 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 Projects 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 7

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

Projects 7

A project is a management system that allows you to define objectives, risks, and controls, perform tests, and compile information for reporting purposes. Projects may also be kno…

GET
/orgs/{org_id}/projects
Get projects
getProjects 6 params → 200400401403404415
POST
/orgs/{org_id}/projects
Create a project
createProject 2 params body → 201400401403404415422
GET
/orgs/{org_id}/projects/{id}
Get a project
getProject 3 params → 200400401403404415
PATCH
/orgs/{org_id}/projects/{id}
Update a project
updateProject 3 params body → 200400401403404415422
DELETE
/orgs/{org_id}/projects/{id}
Delete a project
deleteProject 3 params → 200202400401403404415422
POST
/orgs/{org_id}/projects/{project_id}/entities
Create project entity link
createProjectEntityLink 2 params body → 201400401403404415422
DELETE
/orgs/{org_id}/projects/{project_id}/entities/{id}
Delete project entity link
deleteProjectEntityLink 3 params → 204400401403404415

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), GetProjectsResponse (3 properties), GetProjectResponse (2 properties), GetProjectResponseWithIncludes (2 properties). Each schema is shown below with its type and property counts.

GetProjectResponse
object
The data associated with the resource.
2 properties 1 required
Error
object
5 properties 1 required
GetProjectsResponse
object
The data associated with the resource.
3 properties 2 required
Errors
object
1 property
UpdateProjectRequest
object
The data associated with the resource.
1 property 1 required
CreateProjectEntityRequest
object
The data associated with the resource.
1 property 1 required
CreateProjectRequest
object
The data associated with the resource.
1 property 1 required
GetProjectResponseWithIncludes
object
The data included in the response.
2 properties 1 required
CreateProjectEntityResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-projects-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 Controls API
Wegalvanize Custom attributes API