Jump to Content
Home
Guides
API Reference
Changelog
v5.80.0
v5.81.0
v5.82.0
v5.82.1
v6.0.0
v6.1.0
v6.2.0
v6.3.0
v6.4.0
v6.5.0
v6.5.1
v6.6.0
v6.6.1
v6.7.0
v6.8.0
v6.9.0-rev1
v6.9.0-rev2
v6.9.0
v6.9.2-rev0
v6.9.4-rev0
v6.9.5-rev0
v6.9.5-rev1
v6.9.6-rev0
v6.9.7-rev0
v6.9.8-rev0
v6.10.0
v6.11.0-rev1
v6.11.0
v6.11.1
v6.11.2-rev1
v6.11.2
v6.11.3
v6.12.0
v6.13.0
v6.14.0
v6.14.1
v6.14.2-rev1
v6.14.2
v6.15.0
v6.15.1
v6.15.2
v6.16.0
v6.16.1-rev1
v6.16.1-rev2
v6.16.1-rev3
v6.16.1-rev4
v6.16.1
v6.16.2
v6.16.3
v6.17.0
v6.18.0
v6.18.1
v6.18.2
v6.18.3
v6.19.0-rev1
v6.19.0
v6.19.1
v6.20.0
v6.20.1
v6.20.2
v6.20.3
v6.20.4
v6.20.5
v6.20.6
v6.20.7
v6.20.8
v6.20.9
v6.20.10-rev1
v6.20.10
v6.20.11-rev1
v6.20.11
v6.20.12
v6.20.13
v6.20.14
v6.20.15
v6.20.16
v6.20.17
v6.20.18
v6.20.19-rev1
v6.20.19
v6.20.20
v6.20.21
v6.20.22
v6.20.23-rev1
v6.20.23
v6.21.0-rev1
v6.21.0
v6.22.0
v6.22.1
v6.22.2
v6.22.3
v6.22.4
v6.22.5
v6.23.0
v6.23.1
v6.23.2
v6.23.3-rev1
v6.23.3
API Reference
v6.23.3-rev1
Home
Guides
API Reference
Changelog
Fetches the list of modules (name, system information, and id)
Search
JUMP TO
RegScale API Documentation v2
RegScale API Documentation
Accounts
Creates a new ATLAS user. Leverages the default .NET Core Identity and extends it with custom fields for ATLAS.
post
Updates the ATLAS user profile
put
Retrieves a list of all activated users in the system
get
Creates a new ATLAS user for questionnaires. Leverages the default .NET Core Identity and extends it with custom fields for ATLAS.
post
Resets the cache
get
Creates new ATLAS users.
post
Creates new RegScale users based on Azure AD account groups
post
Adds the specified user to the specified role
post
Checks to see if the specified user has the specified role
get
Deletes the specified role for this user
del
Finds the user's manager
get
Finds the user's manager by user ID
get
Retrieves a list of all activated users in the system
get
Get all inactive users for the current tenant.
get
Retrieves a list of all activated users in the system
get
Retrieves users by tenant based on whether or not they receive email notifications
get
Retrieves a list of all activated users in the system by tenant
get
Filters users based on the specified criteria
get
Get a filtered list of inactive users.
get
Filters users based on the role provided
get
Get the number of user logins by month over the last year.
get
Activate or deactivate a user.
get
Retrieves the user based on the provided user name
get
Retrieves the user by their ATLAS User ID
get
Retrieves the list of available ATLAS roles
get
Retrieves all roles for the specified user
get
Determines if current user is a delegate
get
Get a user's delegates.
get
Changes the user's profile picture
post
Changes the user's profile picture
post
Aggregator
Retrieves all subsystem record counts for the given parent record
get
Retrieves all subsystem record counts for the given parent record
get
Retrieves all child record counts for the given parent record
get
Retrieves a specific security plan statusboard
get
Retrieves a specific component statusboard
get
Retrieves a specific supply chain statusboard
get
Retrieves a specific policy statusboard
get
Retrieves a specific project statusboard
get
AssessmentPlan
Retrieves all assessment plans as a short list
get
Retrieves all assessment plans as a short list that have one or more lines of inquiry
get
Retrieves total assessment plan count
get
Graphs assessment plans based on the provided column and grouping config
post
Graphs assessment plans based on the provided date range
get
Filters assessment plans based on the specified criteria
post
Retrieves all assessment plans based on the custom field criteria provided
get
Creates a new assessment plan record
post
Updates an assessment plan record
put
Deletes an assessment plan record
del
Retrieves assessment plan
get
AssessmentResults
Retrieves an Assessment Result
get
Retrieves a List of Assessment Results with details from the assessment plan
get
Retrieves a List of Assessment Results
get
Creates a new assessment result
post
Creates a batch of new Assessment Results based on the provided array
post
Updates an assessment result
put
Deletes an assessment result
del
Assessments
Retrieves list of assessments for a user that aren't cancelled or completed within the number of days provided
get
Retrieves all assessments for the given parent record
get
Retrieves all existing lightning assessments for the given parent record
get
Retrieves all assessments for the given grandparent record
get
Retrieves all assessments for the given master assessment
get
Retrieves total assessment count
get
Preview batch recurring assessments based on the criteria specified.
post
Creates recurring assessments based on the criteria specified
post
Processes lineage for the given assessment #
get
Gets the last and next upcoming assessment
get
Provides assessment timeline data for the given parent
get
Retrieves list of assessments due in the month/year of the date provided
get
Graphs assessments based on the provided column and grouping config
post
Graphs assessments based on the provided column and grouping config
get
Graphs assessment schedule based on date range and the field specified
get
Retrieves all assessments with planned start, planned finish, or actual finish within the given date range
get
Retrieves all assessments with due dates within the given date range that are not complete
get
Retrieves all assessments completed within the given date range
get
Group by owner then status based on date range
get
Group by owner then status based on date range
get
Group by owner then status based on date range
get
Group by owner then status based on date range
get
Gets data for main dashboard
get
Gets data for main dashboard
get
Gets data for main dashboard
get
Gets data for main dashboard
get
Graphs assessments by due date, shows on time and late
get
Graphs assessments by due date and status, shows statuses of not late, and shows late if late
get
Run the specified report for assessments
get
Retrieves all assessments based on the custom field criteria provided
get
Filters assessments based on the specified criteria
post
Creates a new assessment
post
Creates a new assessment
post
Creates a batch of new assessments based on the provided array from the MITRE Heimdall tool
post
Updates an assessment record
put
Delete an assessment.
del
Retrieves an assessment
get
Retrieves an assessment
get
Retrieves an assessments where OtherIdentifier starts with strId
get
Retrieves an assessment count completed on schedule for the year
get
Filter assessments that are due soon based on the specified criteria.
get
AssetMapping
Filters asset mappings
get
Creates a new asset mapping
post
Deletes a mapping
del
Retrieves an asset mapping
get
Retrieves all asset mappings for a given component
get
Retrieves all component mappings for a given asset ID
get
Retrieves all asset mappings for a given component ID
get
Assets
Get drilldown information for assets charts (main dashboard).
get
Retrieves total number of assets for current user
get
Retrieves a count of assets by component for all related components for the specified security plan
get
Get all assets for a parent record.
get
Get assets based on given search criteria.
post
Get all assets for a given security plan.
get
Graphs assets based on the provided column and grouping config
post
Graphs assets based on the provided date range
get
Filters assets based on specified criteria and date ranges
post
Retrieve asset counts based on the provided group by
get
Retrieve assets counts based on the group by provided for the given parent.
get
Get count of assets based on the year and category specified
get
Run the specified report for assets
get
Filters assets based on the specified criteria
post
Retrieves all assets based on the custom field criteria provided
get
Creates a new asset
post
Create a batch of assets.
post
Update a batch of assets.
put
Update an existing asset.
put
Delete an asset.
del
Get an asset by ID.
get
Authentication
Handles login event for RegScale -- API v2.0
post
/api/authentication/logout/{userId}
post
Changes password for the user
post
Activate the user
post
Retrieves the user ID (GUID) for a given user name
get
Check the provided JWT to see if it is valid. (DEPRECATED)
get
Check the provided JWT to see if it is valid.
post
/api/authentication/refresh-token
post
Gets Access Logs for the User
get
Gets Access Logs for the User
get
Gets Access Logs for the User
get
Gets Daily Access Logs for the User
get
BusinessImpactAssessment
Retrieves all records for the given risk
get
Get all records for the given risk and type.
get
Creates a new record
post
Update an existing record.
put
Delete a record.
del
Retrieves a specific record
get
CapabilityMapping
Filters capability mappings
get
Creates a new capabiltiy mapping
post
Deletes a mapping
del
Retrieves a capability mapping
get
Retrieves all mappings for a given capability
get
Retrieves all capability mappings for a given program ID
get
Retrieves all programs for a given capability ID
get
Cases
Retrieves total number of cases
get
Retrieves all cases for the parent record
get
Graphs cases based on the provided column and grouping config
post
Filters cases based on specified criteria and date ranges
post
Graphs cases based on the provided date range
get
Gets data for cases card on main dashboard
get
Graphs complete/incomplete cases for main dashboard
get
Graphs cases based on the provided column and grouping config
get
Graphs cases based on the provided column and grouping config (parent module)
get
Graphs Cases status by date due based on date range
get
Graphs cases based on date range
get
Run the specified report for cases
get
Filters cases based on the specified criteria
post
Retrieves all cases based on the custom field criteria provided
get
Creates a new case
post
Updates an case record
put
Deletes an case
del
Retrieves a case
get
Catalogs
Get the number of catalogs for the current user.
get
Get a collection of catalogs for the given user.
get
Get security control implementation counts grouped by family.
get
Gets a catalog by ID for the current user.
get
Get a list of the current user's catalogs filtered based on the specified criteria.
post
Get data to help graph information about the current user's catalogs.
post
Convert the security controls' types for a given catalog to "Mapping".
get
Create a new catalog for the current user.
post
Update an existing catalog for the current user.
put
Delete a catalog.
del
Get a catalog by ID for the current user.
get
Get a catalog by GUID for the current user
get
Get a list of catalog titles based on a given array of catalog IDs.
post
Imports and uploads a catalog.
post
Exports a catalog along with security controls, parameters, objectives, tests, and CCIs.
get
Get a list of non-installed catalogs from the RegScale catalog registry.
get
Get a list of the current user's catalogs filtered based on the specified criteria.
post
Returns metadata for installed catalogs with available updates.
get
Returns an object to indicate if the catalog file is valid and if the catalog is already installed.
post
Get a list of UCF catalogs (Authority Documents) available for import.
get
Determine if the user has a UCF API key.
get
Compares a new catalog file with an existing catalog to identify differences and optionally updates the database. Supports generating detailed reports in different structures and applying updates directly.
post
Get the update report for the update catalog modal.
get
Update a given catalog to the latest version.
put
Update a given catalog to the latest version.
put
Get the update report for the UCF catalog modal.
get
Update a given catalog to the latest version.
put
Get Catalogs with Mappings
get
Get the list of installed UCF catalogs.
get
Get the control framework gap report.
post
Get the UCF control overlap report.
post
Categorization
Get the categorization list.
get
Filter categorizations based on the specified criteria.
post
Create a new categorization.
post
Update a categorization using the provided model.
put
Delete a categorization.
del
Get a categorization.
get
Get a categorization with details.
get
Determine if a categorization name is already in use, excluding the current record if an ID is provided.
get
Determine if a categorization name is already in use (for new entries).
get
CategorizationAnswer
Creates a new categorization answer
post
Updates a categorization answer record
put
Deletes a categorization answer
del
Retrieves a categorization answer
get
Retrieves a categorization answer by its parent categorization instance
get
CategorizationInfo
Creates a new categorization info type
post
Updates a categorization info record
put
Deletes a categorization info type
del
Retrieves a categorization info type
get
Retrieves a categorization info type by its parent categorization instance
get
CategorizationInstance
Creates a new categorization instance
post
Updates a categorization instance record
put
Deletes a categorization instance
del
Retrieves a categorization instance
get
Retrieves a categorization instance by its parent
get
Applies the categorization engine to the selected record
post
CategorizationQuestion
Get the basic question list for the categorizations by parent.
get
Filter categorization questions based on the specified criteria.
post
Create a new categorization question.
post
Update a categorization question using the provided model.
put
Update a categorization question using the provided model.
put
Delete a categorization question.
del
Get a categorization question with details.
get
Determine if a categorization question name is already in use.
get
Determine if a categorization question name is already in use
get
CausalAnalysis
Retrieves total causal analysis count
get
Retrieves all causal analysis for the parent record
get
Retrieves list of overdue causal analysis
get
Retrieves list of causal analysis due in the month/year of the date provided
get
Graphs causal analysis based on the provided column and grouping config
post
Graphs causal analyses based on the provided date range and groups by strGroupBy column
get
Graphs causal analyses based on the provided date range
get
Filters causal analysis based on the specified criteria
post
Retrieves all causal analysis based on the custom field criteria provided
get
Creates a new causal analysis
post
Updates a causal analysis record
put
Deletes a causal analysis
del
Graphs complete/incomplete causals for main dashboard
get
Gets data for causal analysis card on main dashboard
get
Retrieves a causal analysis
get
Run the specified report for issues
get
Graphs Causal Analysis by due date based on date range
get
Graphs completed Causal analysis schedule based on date range
get
Graphs Causal Analysis status by date due based on date range
get
Dashboard of Issues
get
CauseCodes
Retrieves all cause codes for a given parent causal analysis
get
Retrieves total cause code count
get
Creates a new cause code
post
Deletes a cause code
del
Causes
Retrieves all causes
get
Retrieves all Causes
get
Retrieves total cause code count
get
Filters causes based on the specified criteria
post
Creates a new cause code
post
Updates a cause record
put
Deletes a cause
del
Retrieves a cause
get
Retrieves a cause by name
get
Cci
Get the CCI for the given security control (by ID).
get
Create a new CCI for the current user.
post
Batch-create multiple CCIs.
post
Update an existing CCI for the current user.
put
Delete a CCI for the current user.
del
Get a CCI by ID for the current user.
get
Changes
Retrieves total number of changes
get
Retrieves all changes for the parent record
get
Graphs changes based on the provided column and grouping config
post
Graphs Cases status by date due based on date range
get
Filters changes based on specified criteria and date ranges
post
Graphs changes based on the provided date range
get
Gets data for changes card on main dashboard
get
Graphs complete/incomplete changes for main dashboard
get
Graphs changes based on the provided column and grouping config
get
Graphs changes based on the provided column and grouping config (parent module)
get
Graphs Changes status by date requested based on date range
get
Graphs changes based on date range
get
Run the specified report for changes
get
Filters changes based on the specified criteria
post
Retrieves all changes based on the custom field criteria provided
get
Creates a new change
post
Updates a change record
put
Deletes an change
del
Retrieves a change
get
ClassificationTypes
Retrieves all classification types in a list
get
Creates a new ClassificationType
post
Creates a batch of new Classification Types based on the provided list
post
Creates a batch of new Classification Types based on the provided array
post
Retrieves classification type by id
get
Updates a classification type record
put
Delete a CalssificationType record
del
Retrieves all classification types in a list ordered by Title
get
Retrieves all classification types in a list, grouped by family
get
Filters ClassificationTypes based on the specified criteria
post
ClassifiedRecords
Create a new classified record.
post
Update a classified record.
put
Get all classified records for the given parent record and module.
get
Delete a classified record.
del
Get a classified record by ID.
get
Comments
Retrieves all comments for a parent record
get
Retrieves all comments for the given parent record
get
Creates a new comment
post
Update an existing comment.
put
Deletes a comment
del
Create multiple comments as a batch.
post
Update multiple comments as a batch.
put
ComponentMapping
Filters component mappings
get
Creates a new component mapping
post
Deletes a mapping
del
Retrieves an component mapping
get
Retrieves all component mappings for a given component
get
Retrieves all component mappings for a given component ID
get
Retrieves all security plans for a given component ID
get
Components
Retrieves all components in a simple list view
get
Retrieves all components for a given parent security plan
get
Retrieves total component count
get
Graphs components based on the provided column and grouping config
post
Graphs security plans based on the provided date range
get
Run the specified report for policies
get
Filters components based on the specified criteria
post
Filters components based on the specified criteria
post
Retrieves all components based on the custom field criteria provided
get
Creates a new component
post
Updates a component record
put
Retrieves task/issue data required for gantt chart
get
Delete a component.
del
Retrieves a component
get
Retrieves a component's evidence
get
Retrieves a component by unique GUID
get
Retrieves a component by external ID
get
Retrieves components titles, given an array of component id's
get
Gets data for main dashboard
get
Gets data for main dashboard
get
OSCAL export of a Component
get
Provides component data for the status board
get
Retrieves child issues of component and related eMass fields
get
/api/components/megaAPI/{intId}
get
Condition
Retrieves all conditions for a parent record
get
Creates a new Condition
post
Updates a Condition record
put
Deletes a condition
del
Retrieves a Condition
get
Config
/api/config/{id}
put
Update an existing configuration.
put
Retrieves config for this instance of RegScale application
get
Retrieves progress in setting up the tenant for the global admin account
get
Indexes logs for faster query performance
get
Deletes logs older than a set number of days
get
Retrieve the license information for installed instance
get
Retrieves total number of RegScale users
get
Retrieve Tenant Color Theme object
get
Updates a categorization record
put
Retrieve the features for the application, these will change over time but will always be defined in the FeatureFlag configuration
get
ConmonDeliverables
Get all continuous monitoring deliverables for a given parent record ID by module.
get
Get all continuous monitoring deliverables for a given parent record ID by module (with file details).
get
Create a new continuous monitoring deliverable.
post
Update a continuous monitoring deliverable.
put
Delete a continuous monitoring deliverable.
del
Create new continuous monitoring deliverable records as a batch.
post
Get a continuous monitoring deliverable by its ID.
get
ControlExternalMappings
Get the control external mappings for the given catalog ID.
get
Get the control external mappings for the given catalog ID.
get
Get control external mappings for a given security control.
get
Get control external mappings for a given control implementation.
get
Create a control external mapping.
post
Create multiple control external mappings.
post
Update an existing control external mapping.
put
Delete a control external mapping.
del
Get a control external mapping by ID.
get
Gets the count by status of all external mappings for a given security plan.
get
Gets the count by impact and status of all external mappings for a given security plan.
get
ControlImplementation
Retrieves all security control implementations count
get
Retrieves short version of all control implementations
get
Retrieves all security control implementations for a given security plan
get
Retrieves all security control implementations for a given parent
get
Get all control assessment results for a given parent.
get
Retrieves a control implementation with all supporting data in a single call
get
Retrieves all control implementations for a given parent modules
get
Retrieves all security control implementations for a given security plan (with control details)
get
Retrieves all security control implementations for a given security plan (with control details)
get
Saves the Compliance history of a given object, notated in the create model. and save compliance history to database.
post
Retrieves all security control implementations with objectives for a given security plan
get
Retrieves all security control implementations for a given array of component IDs
post
Retrieves all security control implementations for a given security plan
get
Retrieves all security control implementations for a given security plan
get
Retrieves all security control implementations for a given security plan
get
Get control implementation list by parent with relates security control information
get
Retrieves all security control implementations for a given parent control
get
Retrieves all security control implementations and their parent control's relevant data for a given security plan
get
Retrieves all security control implementations and their parent control's relevant data for a given security plan
get
Retrieves all security control implementations and their parent control's relevent data for a given component
get
Retrieves all security control implementations and their parent control's relevant data for a given security plan
get
Provides control implementation data for export
get
Retrieves basic security control implementation data for a given security plan
get
Retrieves all security control implementations for a given security plan - grouped by date assessed (Month/Year)
get
Retrieves all security control implementations for a given parent- grouped by date assessed (Month/Year)
get
Retrieves all security control implementations for all assets under a component
get
Graphs controls based on the provided date range
get
Retrieves all security control implementations for a given control - grouped by date assessed (Month/Year)
get
Retrieves all security control implementations by status for a given parent
get
Retrieves all security control implementations by status for a given parent control
get
Retrieves all security control implementations by owner for a given parent security plan
get
Retrieves all security control implementations by owner for a given parent control
get
Retrieves all security control implementations by last assessment result for a given parent security plan
get
Retrieves all security control implementations by last assessment result for a given parent control
get
Retrieves all security control implementations by process maturity level for a given parent
get
Retrieves all security control implementations by practice maturity level for a given parent
get
Retrieves all security control implementations by status for a given control
get
Retrieves all security control implementations by practice maturity level for a given control
get
Retrieves all security control implementations by process maturity level for a given control
get
Accepts a control implementation id, performs an audit, and returns the results.
get
Graphs controls based on the provided column and grouping config
post
Filters controls based on the specified criteria
post
Filters controls based on the specified criteria
post
Returns number of controls based on the specified criteria
post
Retrieves all controls based on the custom field criteria provided
get
Creates a new security control implementation
post
Creates a batch of new control implementations based on the provided array
post
Updates a batch of control implementations based on the provided array
post
Reassign control implementations to a new owner.
post
Updates a security control implementation record
put
Delete a control implementation.
del
Retrieves a security control implementation
get
Updates a security control implementation record's status and weight
put
Graphs issues based on the provided column and grouping config (parent module)
get
Graphs control implementations based on the provided column and grouping config (Control ID)
get
Graphs controls based on parent module and catalogue
get
Retrieves all security control implementations for a given security plan, then groups by family
get
Graphs CIs based on the provided Security Plan
get
Run the specified report for CIs
get
Retrieves all controls for a given parent module and id
get
Retrieves all controls for a given parent module and id
get
Retrieves all controls for all assets that fall under a component
get
Retrieves all controls for all assets that fall under a component
get
Obtain the control status by owner for dashboard rollups
get
Gets all relevant context for a given security control
get
Determines overall completeness for a given control implementation.
get
ControlObjectives
Get the control objectives for the given catalog ID.
get
Get the control objectives for the given catalog ID.
get
Get control objectives for a given security control.
get
Create a control objective.
post
Create multiple control objectives.
post
Update an existing control objective.
put
Delete a control objective.
del
Get a control objective by ID.
get
ControlParameters
Get the control parameter for the given security control (by ID).
get
Create a security control parameter.
post
Batch-create multiple security control parameters.
post
Update a security control parameter.
put
Delete a security control parameter.
del
Get a security control parameter by ID.
get
ControlTestPlans
Get the security control test plan for the given control test plan (by ID).
get
Create a security control test plan.
post
Batch-create multiple security control test plans.
post
Update a security control test plan.
put
Delete a security control test plan.
del
Get a security control test plan by ID.
get
ControlTestResults
Retrieves a Control Test Result
get
Retrieves a Control Test Result
get
Retrieves a List of Control Test Results
get
Creates a new control test result
post
Updates a test result
put
Deletes a test result
del
ControlTests
Retrieves a Control Test
get
Creates a new control test
post
Creates a batch of new control tests based on the provided array
post
Updates a test
put
Delete a control test.
del
Gets control tests by parent control implementation
get
Gets control tests by parent control implementation
get
Gets control tests by parent requirement
get
Cryptography
Retrieves all Cryptography for a parent record
get
Creates a new Cryptography record
post
Updates a Cryptography record
put
Deletes a Crytographic Module record
del
Retrieves a Cryptography record
get
CustomFields
Retrieves custom fields for one module
get
Retrieves custom fields for one module
get
Retrieves required custom fields for one module
get
Retrieves custom field by id
get
Filters custom fields for one module
get
CustomFieldsData
Retrieves custom fields for one module's record
get
CustomFieldsSelectItems
Get custom fields select items
get
Get custom fields select items for a request
get
Dashboard
Retrieves dashboard widget
get
Data
Retrieves all data for the given parent record
get
Creates a new data record
post
Creates a batch of new data based on the provided array
post
Update a batch of data objects.
put
Updates a data object
put
Deletes a data object
del
Retrieves a data record
get
DataCalls
Retrieves data calls for the provided user ID that aren't cancelled or completed within the number of days provided
get
Retrieves total data call count
get
Retrieves list of overdue data calls
get
Graphs complete/incomplete data calls for main dashboard
get
Gets data for main dashboard
get
Gets data for main dashboard
get
Gets data for main dashboard
get
Creates recurring data calls based on the criteria specified
post
Retrieves list of data calls due in the month/year of the date provided
get
Graphs data calls based on the provided column and grouping config
post
Graphs data calls based on the provided date range
get
Filters data calls based on the specified criteria
post
Retrieves all data calls based on the custom field criteria provided
get
Creates a new data call
post
Updates a data call record
put
Deletes a data call
del
Retrieves an data call
get
Run the specified report for exceptions
get
Graphs data calls by due date based on date range
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Dashboard of Data calls
get
Graphs Data Calls schedule based on date range
get
Retrieves all Data Calls with due dates within the given date range
get
Retrieves all Data Calls with date due, date requested, or date completed within the given date range
get
DataCenter
Retrieves data centers for a parent record
get
Creates a new data center
post
Updates a Data Center record
put
Deletes a data center record
del
Retrieves a Data Center Record
get
DateExtensions
Retrieves date extension requests for a parent record
get
Creates a new date extension record
post
Updates a Date Extension record
put
Deletes a date extension record
del
Retrieves a Date Extension Record
get
Delegates
Retrieves all delegates for a given user
get
Creates a new delegate
post
Deletes a delegate
del
Documents
Export a system security plan (SSP) as a Microsoft Word document.
get
Export an SSP Component as an OSCAL-formatted XML file.
get
Export an SSP Component as a Microsoft Word document.
get
Export an SAP/SAR Master Assessment as a Microsoft Word document.
get
Export Test Case Procedures from RegScale to a FedRAMP Test Case Procedures formatted excel document
get
Email
Sends an email
post
Retrieves the domain URL for use in email links
get
Default address for sending ADMIN emails (i.e. to activate new users)
get
Filter the user's email records.
get
Filter a given user's email records.
get
Retrieve an email by ID for the current user.
get
Get an email.
get
Events
Creates a new event
post
Updates an event record
put
Deletes an event
del
Retrieves an event
get
Retrieves an event
get
Retrieve all event topics.
get
Filters event topics based on the specified criteria
get
Evidence
Retrieves total evidence count
get
Graphs evidence based on the provided column and grouping config
post
Graphs evidence based on the provided date range
get
Gets list of evidence due within a date range
get
Retrieves all control implementations for a given piece of evidence
get
Retrieves all evidence for a given control implementation
get
Retrieves all evidence for a given security plan
get
Filters evidence based on the specified criteria
post
Retrieves all evidence based on the custom field criteria provided
get
Creates a new evidence record
post
Updates an evidence record
put
Delete evidence
del
Retrieves evidence
get
Retrieves aggregate data for evidence locker
get
Filter evidence due soon based on the specified criteria.
get
EvidenceMapping
Retrieves all evidence mappings by evidence #
get
Retrieves all evidence mappings by evidence #
get
Retrieves total evidence mapping count
get
Creates a new evidence record
post
Creates multiple new evidence record
post
Deletes an evidence record
del
Retrieves evidence
get
Exceptions
Retrieves total exception count
get
Retrieves # of exceptions in an expired status
get
Retrieves all exceptions for a given parent record
get
Graphs exceptions based on number submitted/approved/expiring by month
get
Retrieves list of exceptions due in the month/year of the date provided
get
Graphs exceptions based on the provided column and grouping config
post
Graphs exceptions based on the provided date range
get
Filters exceptions based on the specified criteria
post
Retrieves all exceptions based on the custom field criteria provided
get
Creates a new exception
post
Updates an exception record
put
Deletes an exception
del
Retrieves an exception
get
Run the specified report for exceptions
get
Graphs exceptions by expiration date based on date range
get
Gets data for exceptions card on main dashboard
get
Dashboard of Exceptions
get
Graphs exceptions based on the provided column and grouping config (parent module)
get
Export
Get metadata/flags for a security plan.
get
Get metadata/flags for a component.
get
Generate an export populated with data from a given security plan.
get
Facilities
Retrieves all facilities
get
Retrieves all facilities
get
Retrieves all active facilities
get
Retrieves total facility count
get
Provides facility data for the status board
get
Filters facilities based on the specified criteria
post
Creates a new facility
post
Updates a facility record
put
Deletes a facility
del
Activates or deactivates the specified facility
get
Retrieves a facility
get
Retrieves a facility by name
get
FileTags
Retrieves a list of records
get
Creates a new record
post
Updates a record
put
Deletes a record
del
Retrieves a record
get
FileUpload
Create a new file.
post
Update a file.
put
Get a list of files for a given record.
get
Get a list of controls/requirements along with their evidence for the given record.
get
Get the file count for a given parent record.
get
Filter files based on the specified criteria.
get
Get all files for a given part.
get
Upload a file.
post
Delete a file.
del
Delete an unencrypted file.
del
Retrieve a file.
get
Download a file.
get
Rename duplicate file names for a given record.
put
FormFieldValue
/api/formFieldValue/saveFormFields/{recordId}/{moduleName}
post
/api/formFieldValue/getFieldValues/{recordId}/{moduleName}/{formId}
get
FunctionalRoleAssignments
Retrieves all functional role assignments for a give role
get
Creates a new functional role assignment
post
Updates a Functional Role Assignment record
put
Deletes a functional role assignment record
del
Determines if the current user is in the specified role
get
Retrieves a Functional Role Assignment Record
get
FunctionalRoles
Retrieves all functional roles
get
Creates a new functional role
post
Updates a Functional Role record
put
Deletes a Functional Role record
del
Retrieves a Functional Role Record
get
Retrieves a Functional Role Record by Name
get
Groups
Retrieves all groups
get
Creates a new group
post
Activates a groups record
get
Updates a groups record
put
Retrieves a group
get
Retrieves all groups for a given user
get
Filters groups based on the specified criteria
get
Retrieves all users for a given group
get
History
/api/history/myHistory/{pageNumber}/{pageSize}
get
Get activity history events for a user.
get
Filters history events by parent
get
Filters history based on specified criteria
post
Retrieves all history events for the specified user over the last year, grouped by month/year
get
Retrieves all history events for the specified record over the last year, grouped by month/year
get
Retrieves all history events for the specified record over the last year, grouped by hour
get
Retrieves history events for the specified time period - grouped by month/year
get
Retrieves history events for the specified time period - grouped by day
get
Retrieves total history events by Module
get
Retrieves total history events by event type
get
Retrieves all history events for a given record, grouped by event type
get
Retrieves all history events for a given record, grouped by user
get
Retrieves number of edit events for a given record
get
Get the number of events by month over the last year.
get
Creates a new history record
post
ImplementationObjectives
Retrieves objective data for the control implementation provided
get
Retrieves assessment data for the given control implementation + objective pair
get
Creates a new Implementation Objective
post
Creates a batch of new implementation objectives based on the provided array
post
Updates an implementation objective record
put
Delete an implementation objective.
del
Retrieves an implementation objective
get
Delete duplicate implementation objectives.
post
Merges a control implementation's objectives with the parent catalogue defaults
get
ImplementationOptions
Retrieves basic option data for the security control provided
get
Creates a new Implementation Option record
post
Creates a batch of new ImplementationOptions based on the provided list
post
Updates an implementation option record
put
Delete a ImplementationOption record
del
Get an ImplementationOption by ID.
get
ImplementingRoles
Retrieves all system implementing roles for a parent record
get
Creates a new role implementation
post
Updates a Implementing Role record
put
Deletes an implementing role record
del
Retrieves an Implementing Role Record
get
Incidents
Retrieves total incident count
get
Retrieves all incidents for the parent record
get
Retrieves short version of all incidents
get
Graphs incidents based on the provided column and grouping config
post
Graphs data incidents based on the provided date range
get
Gets data for main dashboard
get
Graphs complete/incomplete incidents for main dashboard
get
Filters incidents based on the specified criteria
post
Retrieves all incidents based on the custom field criteria provided
get
Creates a new incident
post
Updates an incident record
put
Deletes an incident
del
Retrieves an incident
get
Run the specified report for incidents
get
Graphs Incidents based on date range
get
Graphs Issues schedule based on date range
get
Dashboard of Incidents
get
Graphs incidents based on the provided column and grouping config (parent module)
get
Inheritance
Creates a new inheritance relationship
post
Retrieves all legacy inherited control implementations
get
Retrieves all inheritance records for the given parent record
get
Retrieves count inheritance records for the given parent record
get
Retrieves all inheritance records for the given parent record with child details
get
Deletes a inheritance relationship
del
InheritedControls
Retrieves all Inherited Controls for a parent record
get
Retrieves all Inherited Controls for a given base control
get
Creates a new Inherited Control
post
Creates a batch of new inherited controls based on the provided array
post
Updates an Inherited Control record
put
Deletes an Inherited Control
del
Retrieves an Inherited Control
get
Interconnections
Retrieves total interconnect count
get
Retrieves all interconnects for the given parent record
get
Retrieves list of interconnects due in the month/year of the date provided
get
Graphs interconnects based on the provided column and grouping config
post
Graphs interconnects based on the provided date range
get
Filters interconnects based on the specified criteria
post
Retrieves all interconnects based on the custom field criteria provided
get
Creates a new interconnect
post
Updates an interconnect record
put
Deletes an interconnect
del
Retrieves an interconnect
get
Run the specified report for interconnections
get
Graphs Interconnects schedule based on date range
get
Gets data for interconnects card on main dashboard
get
Graphs interconnections based on the provided column and grouping config (parent module)
get
Issues
Retrieves issues for provided user ID that aren't closed or cancelled within the number of days provided
get
Retrieves the number of open issues with deviations for a given security plan
get
Set the quality assurer.
put
Remove the quality assurer.
put
Processes lineage for the given issue #
get
Retrieves total issue count
get
Get the total count of open issues for the given parent.
get
Retrieves all issues with due dates within the given date range
get
Retrieves all issues with due dates within the given date range
get
Retrieves all issues with due dates within the given date range
get
Retrieves all issues for all time
get
Retrieves all issues with due dates within the given date range
get
Retrieves all issues with due dates within the given date range
get
Retrieves all issues with due dates for all time
get
Retrieves all issues with due dates within the given date range
get
Retrieves all issues with due dates within the given date range
get
Retrieves all issues closed within the given date range
get
Retrieves all issues where the provided integration field is populated
get
Retrieves all active issues where the provided integration field is populated
get
Retrieves short version of all issues
get
Get all issues for the given parent record and other search criteria.
post
Get the issue count summary.
get
Retrieves all issues for the given parent record
get
Get count of POAMs for a given parent record.
get
Get all POAMs for a given issue, child assets of that issue, and components of the child assets.
get
Retrieves all issues for the given grandparent record
get
Retrieves all issues based on the custom field criteria provided
get
Provides issue timeline data for the given parent
get
Retrieves list of issues due in the month/year of the date provided
get
Graphs issues based on the provided column and grouping config
post
Graphs issues based on the provided date range
get
Filters issues based on the specified criteria
post
Create an issue.
post
Update an issue (v2).
put
Delete an issue.
del
Update an issue's parent.
put
Update a batch of issues (v2).
put
Create a batch of issues.
post
Screen a given issue.
put
Retrieves an issue
get
Retrieves child issues of component and related eMASS fields
get
Retrieves child issues of security plan, and related eMASS fields
get
Filter issues due soon based on the specified criteria.
get
Retrieves the issue
get
Retrieves the issue
get
Retrieves the issue by using the Salesforce case number
get
Retrieves the issue
get
Retrieves the issue
get
Retrieves the issue
get
Retrieves the issue
get
Retrieves the issue
get
Retrieves issues with a specific Wiz CICD Scan vulnerability identifier
get
Retrieves active issues with a specific Wiz CICD Scan vulnerability identifier
get
Retrieves the issue
get
Retrieves the issue by using the Microsoft Defender 365 Recommendation ID
get
Retrieves the issue by using the Vulnerability ID
get
Retrieves the issue by using the Microsoft Defender 365 Alert ID
get
Retrieves the issue by using the Microsoft Defender for Cloud ID
get
Run the specified report for issues
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Dashboard of Issues
get
Get drilldown information for issues charts (main dashboard).
get
Gets data for main dashboard
get
Graphs complete/incomplete incidents for main dashboard
get
Graphs issues based on the provided column and grouping config (parent module)
get
Get issues by IntegrationFindingId with an optional status filter.
get
LdapAuth
Handles LDAP login event for ATLAS
post
Get list of members of the Atlas AD group
get
Sync members of the Atlas AD group
get
Deletes or deactives at LDAP users
get
LeveragedAuthorization
Retrieves all leveraged authorization records for a parent record
get
Creates a new leverage authorization record
post
Updates a Leveraged Authorization record
put
Deletes a leveraged authorization record
del
Retrieves a Leveraged Authorization Record
get
LinesOfInquiry
Retrieves all lines of inquiry records for a parent record
get
Creates a new line of inquiry record
post
Updates a Line of Inquiry record
put
Deletes a lines of inquiry record
del
Retrieves a Line of Inquiry Record
get
Links
Retrieves all links for the given parent record
get
Retrieves all links for the given parent record
get
Retrieves all links for the given parent record
get
Creates a new link
post
Updates a link record
put
Deletes a link
del
Create multiple links as a batch.
post
Update multiple links as a batch.
put
Logging
Filter log events based on the specified criteria.
get
Get the total error counts by month for the last year.
get
Get SQL Server storage statistics.
get
Mapping
Retrieves a specific mapping (combination of mapping ID and control ID)
get
Retrieves all mapped controls for a given control
get
Retrieves all mapped controls for a given control
get
Retrieves all mapped controls for a given catalogue
get
Creates a new mapping
post
Deletes a control mapping
del
MasterAssessments
Get a given master assessment by its ID.
get
Updates the master assessment for the given ID with new model information.
put
Delete a master assessment.
del
Get the in-progress master assessments for the given parent ID and parent module.
get
Get the master assessments for the given parent ID and parent module ordered by planned finish date.
get
Get all assessments whose parent is the given master assessment ID.
get
Create a new master assessment.
post
Metadata
Retrieves all metadata, grouped by field
get
Filters metadata based on the specified criteria
get
Creates a new metadata record
post
Retrieves all metadata by module and field
get
Retrieves all metadata by module
get
Returns seeding options for an administrator
get
Retrieves all metadata by module and field
get
Activates or deactivates a metadata record
get
Updates a metadata record
put
Deletes a metadata record
del
Retrieves a metadata record
get
Milestones
Retrieves all milestones for a parent record
get
Creates a new Milestone
post
Updates a Milestone record
put
Deletes a milestone
del
Retrieves a Milestone
get
Mitigations
Filters mitigations
get
Creates a new mitigation
post
Updates a mitigation
put
Deletes a mitigation
del
Retrieves a mitigation
get
Retrieves all risk/control mappings for a given control
get
Retrieves all threat mappings for a given risk ID
get
Retrieves all risk mappings for a given control ID
get
Module
Builds a new form in RegScale via the Form Builder
post
Fetches the list of modules (name, system information, and id)
get
Fetches a module including forms and fields by moduleId
get
/api/modules/multiple
post
Get the list of modules, including form tabs and form fields.
get
Resets the Labeling for a module (formTabs, formFields, formFieldChoices)
get
NamespaceMapping
Creates a new classified record
post
Creates a batch of namespace data
post
Retrieves all oscal namespaces mapped to a parameter
get
Deletes an oscal namespace/parameter mapping
del
Navigation
Gets the number of children by module type for a record
get
Gets the children of a record for particular module type
get
Organizations
Retrieves all organizations
get
Retrieves all Orgs
get
Retrieves all active organizations
get
Retrieves all active organizations - short list of fields
get
Retrieves total organization count
get
Filters organizations based on the specified criteria
post
Creates a new organization
post
Updates an organization record
put
Deletes an organization
del
Activates or deactivates the specified organization
get
Retrieves an organization
get
Retrieves an organization by name
get
OscalNamespaces
Updates a test
put
Archives an OSCAL Namespace
del
Retrieves an oscal namespace
get
Parameters
Retrieves all parameters for a given parent control implementation
get
Retrieves total parameter count
get
Creates a new parameter
post
Updates a parameter record
put
Delete a parameter.
del
Retrieves a parameter
get
Retrieves a parameter by unique GUID
get
Merges a control implementation's parameters with the parent catalogue defaults
get
Policies
Retrieves a list of policies with minimal data
get
Retrieves total policy count
get
Retrieves all policies for the given parent record
get
Retrieves all related controls for a given policy
get
Retrieves list of policies due in the month/year of the date provided
get
Provides policy data for the status board
get
Graphs policies based on the provided column and grouping config
post
Retrieves task/issue data required for gantt chart
get
Graphs policies based on the provided date range
get
Gets data for policies card on main dashboard
get
Dashboard of Policies
get
Run the specified report for policies
get
Graphs policies schedule based on date range
get
Filters policies based on the specified criteria
post
Retrieves all policies based on the custom field criteria provided
get
Creates a new policy
post
Updates a policy record
put
Deletes a policy
del
Retrieves a policy
get
Uploads word document and returns the html string
post
Uploads word document and returns the html string
post
Uploads word document and returns the html string
post
Exports a policy template doc with the parameters value substituted in
post
Saves/Updates a policy template doc
post
Saves/Updates a policy template doc
post
Check if a policy template document exists in the files subsystem.
get
PortsProtocols
Get all ports and protocols for a given parent record.
get
Create a new ports and protocols record.
post
Update an existing ports and protocols record.
put
Delete an existing ports and protocols record.
del
Get a ports and protocols record.
get
Get all ports and protocols for the given security plan ID.
get
Posts
Filters history based on specified criteria
post
Filters history based on specified criteria
post
Filters history based on specified criteria
post
Retrieves filtered News Feed posts
post
Retrieves a News Feed Post
post
Retrieves a News Feed Post
post
Retrieves most recent news Feed Post
get
Retrieves a News Feed Post
get
Creates a new News Post
post
Attempts to send a test message
get
Retrieves News Feed posts over the specified number of days, grouped by Month/Year
post
Shows News Feed counts grouped by module
get
Privacy
Retrieves all privacy records for a parent record
get
Creates a new privacy record
post
Updates a Privacy record
put
Deletes a privacy record
del
Retrieves a Privacy Record
get
ProfileLinks
Creates a new profile mapping
post
Deletes a security profile link
del
Retrieves all profiles linked to any module with a builder module options: security plan, component, policy, projects, supply chain
get
ProfileMapping
Retrieves a specific security profile mapping
get
Retrieves all mappings for a given profile
get
Retrieves all catalogs imported for a given profile
get
Creates a new profile mapping
post
Creates a batch of new profile mappings based on the provided array
post
Updates a profile mapping record
put
Deletes a profile mapping
del
Retrieves a profile mapping
get
Creates a batch of new profile mappings based on the provided array
post
Deletes a profile mapping - with control and profile IDs to find the mapping
del
Profiles
Retrieves basic data for the profiles
get
Retrieves a list of control data for a given profile ID
get
Retrieves profiles with their controls
post
Retrieves total security profile count
get
Graphs security profiles based on the provided column and grouping config
post
Applies a specific profile to a RegScale record based on the ID and Module key value pair
post
Filters security profiles based on the specified criteria
post
Retrieves all profiles based on the custom field criteria provided
get
Creates a new security profile
post
Updates a security profile record
put
Deletes a security profile
del
Retrieve security profile for the specified ID and record in history service
get
Retrieves a security profile
get
Projects
Retrieves a list of projects with minimal data
get
Retrieves list of projects due in the month/year of the date provided
get
Retrieves task/issue data required for gantt chart
get
Provides project data for the status board
get
Graphs projects based on the provided column and grouping config
post
Graphs projects based on the provided date range
get
Filters projects based on the specified criteria
post
Retrieves all projects based on the custom field criteria provided
get
Creates a new project
post
Updates a project record
put
Deletes a project
del
Retrieves a project
get
Run the specified report for projects
get
Graphs Projects schedule based on date range
get
Dashboard of Projects
get
Gets data for causal analysis card on main dashboard
get
Graphs complete/incomplete projects for main dashboard
get
Properties
Retrieves all properties for the given parent record
get
Get all properties based on the secondary linkage.
get
Get all properties based on the primary and secondary linkage.
get
Creates a new property
post
Creates a batch of new properties based on the provided array
post
Update a batch of properties.
put
Updates a property record
put
Deletes a property
del
PushNotifications
Create a new push notification.
post
Get a notification by its ID.
get
Get the number of unread notifications for the given user.
get
Get the unread notifications for the given user.
get
Get the unread notifications for the given user and notification type.
get
Dismiss a given notification.
get
Dismiss all notifications for a given user and notification type.
get
Queries
Retrieves all reports for the user
get
Retrieves all reports for the user for a given module
get
Creates a new query
post
Retrieves a query and parameters
get
Deletes a query and parameters
del
QuestionnaireInstances
Retrieves total questionnaireInstance count
get
Graphs questionnaires based on the provided column and grouping config
post
Filters questionnaires based on the specified criteria
post
Get all questionnaire instances of a parent questionnaire.
get
Creates a new questionnaire instance
post
Updates a questionnaireInstance record
put
Deletes a questionnaireInstance
del
Delete questionnaire instances.
post
Retrieves a questionnaireInstance
get
Retrieves a questionnaireInstance
post
Retrieves a questionnaire
get
Responds if the questionnaire instance requires login
get
Updates a questionnaire's responses in the original record.
put
Updates a questionnaire's feedback in the original record.
put
Changes the State of a Instance
put
Changes the State of a Instance
put
Submit a questionnaire instance for feedback.
put
Reopen a questionnaire instance that has already been reviewed and passed.
put
Export a questionnaire instance to an Excel file.
get
Questionnaires
Get a list of active questionnaires.
get
Retrieves total questionnaire count
get
Retrieves the title for a questionnaire
get
Returns if self-assignment is enabled for the questionnaire
get
Returns the ID for the Questionnaire
get
Graphs questionnaires based on the provided column and grouping config
post
Filters questionnaires based on the specified criteria
post
Creates a new questionnaire with default values
post
Creates a new questionnaire
post
/api/questionnaires/createInstancesFromQuestionnaires
post
Create questionnaire instances based on a questionnaire.
post
Create a recurring questionnaire assignment.
post
Get the recurring assignments for a questionnaire.
get
Delete the recurring assignments for a questionnaire.
del
Updates a questionnaire record
put
Deletes a questionnaire
del
Uploads the file
post
Uploads bulk email assignment file
post
Gets the instances that can be updated
get
Updates instances to match the parent questionnaire
put
Retrieves a questionnaire
get
Export a questionnaire to an Excel file.
get
Export a questionnaire template to an Excel file.
get
Export multiple questionnaire instances to an Excel file.
post
Export multiple questionnaire instances to an Excel file.
get
Questions
Get all questions for an existing questionnaire.
get
Get a question by its ID.
get
Create a question for a questionnaire.
post
Update an existing question for a questionnaire.
put
Delete an existing question from a questionnaire.
del
Get the section index when a question is moved between sections.
post
Update subsequent section indexes that follow the given deleted question.
put
Update subsequent section indexes that follow the given newly inserted question.
put
Update the section indexes of subsequent questions when a new question is inserted and then cancelled.
put
Move a question up within a section.
put
Move a question down within a section.
put
Rbac
Get the access levels for the given entities.
post
Get RBAC records for a module record
get
Adds an module record's RBAC record
get
Deletes a module record's RBAC record
del
Sets a parent's isPublic value
get
Gets RBAC detail about a record
get
/api/rbac/reset/{moduleId}/{parentId}
get
References
Retrieves all references for a parent record
get
Creates a new reference
post
Updates a Reference record
put
Deletes a reference
del
Retrieves a Reference
get
Relationships
Filters relationship events by base id
get
Creates a new relationship
post
Updates a relationship
put
Deletes a relationship
del
Retrieves a relationship
get
Retrieves a relationship by base ID and related ID
get
Retrieves list of ID's related to an issue (base ID)
get
Retrieves list of ID's related to an issue
get
ReportBuilder
/api/reportbuilder/getactivemodulelist
get
/api/reportbuilder/getFieldsWithTypesForModule/{moduleName}
get
Get the list of modules, including form tabs and form fields.
get
/api/reportbuilder/create
post
/api/reportbuilder/update
put
/api/reportbuilder/getReportBuilderConfig/{id}
get
/api/reportbuilder/generateReport
post
/api/reportbuilder/aggregateReport
post
/api/reportbuilder/exportReport
post
/api/reportbuilder/updatePreview
post
/api/reportbuilder/getAllReports
get
/api/reportbuilder/shareReportWithUser
post
/api/reportbuilder/shareReportWithGroup
post
Create a new report subscription.
post
Delete a report subscription by ID.
del
Get all report subscriptions for a specific report builder configuration.
get
RequirementMapping
Filters requirement mappings
get
Creates a new requirement mapping
post
Deletes a mapping
del
Retrieves a requirement mapping
get
Retrieves all mappings for a given requirement
get
Retrieves all control mappings for a given requirement ID
get
Retrieves all requirements for a given control ID
get
Requirements
Retrieves all requirements for a given parent
get
Retrieves all requirements for a given parent module and id
get
Retrieves all control assessment results for a given parent
get
Get requirement list by parent with related security control information
get
Retrieves all requirements and their parent control's relevant data for a given policy
get
Retrieves basic requirement data for a given parent
get
Graphs assessments based on the provided column and grouping config
post
Graphs requirements based on the provided date range
get
Graphs Issues schedule based on date range Graphs Issues schedule based on date range
get
Graphs issues based on the provided column and grouping config (parent module)
get
Filters requirements based on the specified criteria
post
Filters controls based on the specified criteria
post
Returns number of controls based on the specified criteria
post
Provides data for the requirements scorecard
get
Retrieves all requirements based on the custom field criteria provided
get
Creates a new requirement
post
Updates a requirement record
put
Deletes a requirement
del
Retrieves a requirement
get
Run the specified report for interconnections
get
Gets data for requirements card on main dashboard
get
Creates a batch of new requirements based on the provided array
post
RiskFinancials
Creates a new financial analysis record
post
Updates a Risk Financial record
put
Deletes a financial risk record
del
Retrieves a Financial Risk Record
get
Retrieves a Financial Risk Record by Parent Risk
get
RiskIncidentMapping
Filters risk incident mappings
get
Creates a new risk/incident mapping
post
Deletes a mapping
del
Retrieves a risk/incident mapping
get
Retrieves all risk/incident mappings for a given component
get
Retrieves all incident mappings for a given risk ID
get
Retrieves all risk mappings for a given incident ID
get
RiskIssueMapping
Filters risk issue mappings
get
Creates a new risk/issue mapping
post
Deletes a mapping
del
Retrieves a risk/issue mapping
get
Retrieves all risk/issue mappings for a given component
get
Retrieves all issue mappings for a given risk ID
get
Retrieves all risk mappings for a given issue ID
get
RiskMatrix
Retrieves all records for the current tenant
get
Retrieves all records for the specified parent risk model
get
Creates a new record
post
Create a batch of records
post
Update an existing record.
put
Delete a record.
del
Retrieves a specific record
get
Deletes all matrix entries for a given risk model
get
RiskModel
Retrieves all records for the current tenant
get
Retrieves all records for the current tenant
get
Creates a new record
post
Update an existing record.
put
Delete a record.
del
Retrieves a specific record
get
Clears the matrix for a given risk model
get
Risks
Processes lineage for the given risk #
get
Retrieves all risks for the given parent record
get
Retrieves all risks for the given grandparent record
get
Retrieves open risks for the given parent module type
get
Get a simplified set of risk records for a given scenario.
get
Get risk counts to support Risk and Control Self-Assessment (RCSA) process visualization.
get
Get a simplified set risk records for a given scenario.
get
Retrieves short version of all risks
get
Provides risk data for the status board
get
Graphs risks based on the provided column and grouping config
post
Graphs risks based on the provided date range
get
Graphs Risks schedule based on date range
get
Filters risks based on the specified criteria
post
/api/risks/graphAllTrends
get
Retrieves all risks based on the custom field criteria provided
get
Creates a new risk
post
Updates a risk record
put
Delete a risk.
del
Retrieves a risk
get
Run the specified report for risks
get
Graphs Risks schedule based on date range
get
Dashboard of Risks
get
Gets data for risks card on main dashboard
get
Graphs complete/incomplete risks for main dashboard
get
Graphs risks based on the provided column and grouping config (parent module)
get
Provides risk data for the status board
get
Retrieves risks for the given status
get
Get risk assessments due soon based on the specified criteria.
get
RiskThreatMapping
Filters risk threat mappings
get
Creates a new risk/threat mapping
post
Deletes a mapping
del
Retrieves a risk/threat mapping
get
Retrieves all risk/threat mappings for a given threat
get
Retrieves all threat mappings for a given risk ID
get
Retrieves all risk mappings for a given threat ID
get
RiskTreatments
Retrieves all treatments for a given parent risk
get
Retrieves total risk treatment count
get
Graphs issues based on the provided column and grouping config (parent module)
get
Creates a new risk treatment
post
Updates a risk treatment record
put
Deletes a risk treatment
del
Retrieves a risk treatment
get
Retrieves a risk treatment by unique GUID
get
RiskTrends
Retrieves all trends for a given parent risk
get
Retrieves all risk assessments scores for a given parent risk
get
Retrieves total risk trend count
get
Creates a new risk trend
post
Updates a risk trend record
put
Deletes a risk trend
del
Retrieves a risk trend
get
Retrieves a risk trend by unique GUID
get
SBOM
Retrieves all SBOM records for a given parent
get
Retrieves total SBOM count
get
Filters SBOMs based on the specified criteria
get
Creates a new SBOM record
post
Retrieves a SBOM record
get
Retrieves a SBOM by unique GUID
get
Deletes a SBOM
del
Update an existing SBOM record.
put
ScanHistory
Retrieves all scan history for a given parent
get
Get all scan histories for assets of a given parent and its child assets recursively.
get
Retrieves total scan count
get
Retrieves scan results for the provided record
get
Filters scans based on the specified criteria
get
Creates a new scan
post
Updates a new scan
put
Create a batch of new scan histories.
post
Retrieves a scan
get
Retrieves a scan by unique GUID
get
SecurityChecklist
Retrieves all security checklists for a given asset
get
Creates a new security checklist
post
Creates a batch of new security checklists based on the provided array
post
Updates a batch of security checklists based on the provided array
post
Updates a Security Checklist record
put
Deletes a security checklist
del
Retrieves a Security Checklist item
get
SecurityControls
Get the security controls for the given catalog (by ID).
get
Get the security controls for the given catalog (by GUID).
get
Get all security controls to support graphing.
post
Get all security controls based on the specified criteria.
post
Get security controls for a given catalog.
get
Get all security controls with a Mapping type for a given catalog.
get
Get the security controls for the given catalog (by ID).
get
Get catalog details for a given catalog ID.
get
Get all security controls with a given catalog ID.
get
Get security controls as well as their parameters, objectives, test plans, and implementation options for a given catalog ID.
get
Get security controls for a given catalog ID that belong to a given security control family.
get
Create a security control.
post
Batch-create multiple security controls.
post
Update a security control.
put
Delete a security control.
del
Get a security control by ID.
get
Get a security control by ID.
get
Get a specific security control for a given catalog.
get
Convert all catalogs to set the sort ID for security controls.
get
SecurityPlans
Obtain the annual loss expectancy per system security plan (SSP)
get
Obtain the residual risk rollup per system security plan (SSP)
get
Gets security control maturity totals by organizer.
get
Gets security control maturity totals by family and organizer.
get
Get security control status totals by family and organizer.
get
Get security control last assessment result totals by family and organizer.
get
Retrieves task/issue data required for gantt chart
get
Creates a new security plan
post
Updates a security plan record
put
Delete a security plan.
del
Updates a security plan System Name
get
Exports a RegScale Security Plan as an OSCAL-formatted XML file
get
/api/securityplans/getCount
get
Retrieves # of security plans that have expired
get
Retrieves a security plan
get
Retrieves a security plan's evidence
get
Retrieves the security Plan by Wiz Project ID
get
Retrieves the security Plan by ServiceNow Assignment Group
get
Retrieves the security Plan by Tenable Asset Group
get
Retrieves the security Plan by Jira Project
get
Dashboard of Security Plans
get
Run the specified report for policies
get
Graphs policies schedule based on date range
get
Graphs security plans and groups them by status (approved, submitted, expired)
get
Create an eMASS POAM export with all issues for an SSP and the issues of its children and related eMASS fields.
get
Export Excel document for Ports and Protocols
get
Export the eMASS SLCM Implementation Plan as an Excel workbook.
get
Export the eMASS SCF Excel document.
get
Export the eMASS CYBERSAFE Excel workbook.
get
Retrieves all related information of an SSP to fill our a SAP/SAR
get
Exports the eMASS Hardware Software list for a given SSP to the Files subsystem as an Excel worksheet.
post
Export Assets of an SSP to an eMASS Hardware Software list excel document
get
/api/securityplans/mainDashboard/{intYear}
get
Graphs security plans based on the provided column and grouping config
post
/api/securityplans/graphByDate/{strGroupBy}/{year}
get
/api/securityplans/userOpenItemsDays/{strUserId}/{intDays}
get
Retrieves a list of security plans with minimal data
get
Retrieves all security plans based on the custom field criteria provided
get
Filters security plans based on the specified criteria
post
Retrieves list of security plans due in the month/year of the date provided
get
Provides security plan data for export
get
Retrieves a list of inheritable security plans with minimal data
get
Provides security plan data for the status board
get
/api/securityplans/megaAPI/{intId}
get
/api/securityplans/getAllCommentsBySecurityPlan/{intId}
get
Export POAMs of an SSP to a FedRAMP Rev5 Risk Exposure excel document
get
Export child controls of an SSP to a FedRAMP CIS/CRM Excel workbook.
get
Export Assets of an SSP to a FedRAMP Rev5 Inventory excel document
get
Retrieves task/issue data required for gantt chart
get
Retrieves task/issue data required for gantt chart
get
SoftwareInventory
Retrieves all software inventory for a given asset
get
Creates a new software inventory entry
post
Creates a batch of new softare inventory based on the provided array
post
Updates a batch of software inventory based on the provided array
post
Updates a Software Inventory record
put
Deletes a software inventory item
del
Retrieves a Software Inventory item
get
Stakeholders
Retrieves total stakeholder count
get
Retrieves all stakeholders for the given parent record
get
Creates a new stakeholder
post
Updates a stakeholder record
put
Deletes a stakeholder
del
Retrieves a stakeholder
get
SupplyChain
Retrieves a list of supply chain contracts with minimal data
get
Retrieves total number of supply chain records
get
Retrieves all supply chain records for the parent record
get
Graphs supply chain records based on the provided column and grouping config
post
Graphs supply chains based on the provided date range
get
Graphs supply chains based on number beginning/ending by month
get
Graphs supply chains based on the provided date range
get
Retrieves task/issue data required for gantt chart
get
Filters supply chain records based on the specified criteria
post
Retrieves all supply chain based on the custom field criteria provided
get
Provides supply chain data for the status board
get
Creates a new supply chain record
post
Updates a supply chain record
put
Deletes a supply chain record
del
Retrieves a supply chain record
get
Retrieves a supply chain record by UUID
get
Retrieves a supply chain record by Ariba ID
get
Retrieves a supply chain record by Stock Symbol
get
Retrieves a supply chain record by NAICs
get
Retrieves a supply chain record by CAGE Code
get
Retrieves a supply chain record by EIN
get
Retrieves a supply chain record by DUNS
get
Gets data for causal analysis card on main dashboard
get
Dashboard of Supply Chain
get
Run the specified report for supply chain
get
Graphs supply chain schedule based on date range
get
SupplyChainRisk
Processes violations and risk data for suppliers
get
Processes violations and risk data for suppliers
get
SystemRoleAssignments
Retrieves all system role assignments for a parent record
get
Creates a new system role assignment
post
Updates a System Role Assignment record
put
Deletes a system role assignment record
del
Retrieves a System Role Assignment Record
get
SystemRoleExternalAssignments
Retrieves all system role external assignments for a parent record
get
Creates a new system role external assignment
post
Updates a System Role Extermal Assignment record
put
Deletes a system role external assignment record
del
Retrieves a System Role External Assignment Record
get
SystemRoles
Retrieves all system roles for a parent record
get
Creates a new system role
post
Create multiple system roles.
post
Updates a System Role record
put
Deletes a system role record
del
Retrieves a System Role Record
get
Tag
Get a list of all tags.
get
Get a list of tags by parent.
get
Create a new tag.
post
Update an existing tag.
put
Create multiple tags.
post
Update multiple tags.
put
Delete a tag.
del
Get a tag by ID.
get
Get records tagged with the given name.
get
Get a tag by name.
get
TagMapping
Create a new tag mapping.
post
Update an existing tag mapping.
put
Get a tag mapping by ID.
get
Get a list of tag mappings by parent.
get
Create multiple tag mappings.
post
Update multiple tag mappings.
put
Delete a tag mapping.
del
Tasks
Retrieves all tasks that aren't cancelled or closed for the given user within the number of days provided
get
Retrieves all tasks for the given parent record
get
Creates recurring tasks based on the criteria specified
post
Gets data for main dashboard
get
Retrieves list of tasks due in the month/year of the date provided
get
Graphs tasks based on the provided column and grouping config
post
Graphs tasks based on the provided date range
get
Filters records due soon based on the specified criteria
get
Filters tasks based on the specified criteria
post
Retrieves all tasks based on the custom field criteria provided
get
Creates a new task
post
Updates a task record
put
Deletes a task
del
Retrieves a task
get
Run the specified report for issues
get
Graphs Issues schedule based on date range
get
Graphs Issues schedule based on date range
get
Dashboard of Issues
get
Graphs Tasks schedule based on date range
get
Retrieves all Tasks with due dates within the given date range
get
Retrieves all tasks with planned start, planned finish, or actual finish within the given date range
get
Retrieves an tasks where OtherIdentifier starts with strId
get
Teams
Retrieves all Teams for a parent record
get
Creates a new Team
post
Updates a Team record
put
Deletes a team
del
Retrieves a Team
get
Tenants
Reseed a tenant's module data
get
Retrieves the application license key
get
Retrieves the application domain
get
Validate and save a UCF API key.
post
API to force RegScale to process inactive users and either notify them or deactivate their accounts
post
Threads
Get threads by parent ID.
get
Create a new thread.
post
ThreatModel
Retrieves total threat model count
get
Retrieves short version of all threat models matching the text provided
get
Retrieves short version of all threat models
get
Graphs threat models based on the provided column and grouping config
post
Graphs threat models based on the provided date range
get
Filters threat models based on the specified criteria
post
Retrieves all threat models based on the custom field criteria provided
get
Creates a new threat model
post
Updates a threat model record
put
Deletes a threat model
del
Get risk rollup data for a given threat model.
get
Get a threat model.
get
Get a threat model with all child scenarios.
get
Graphs threat models based on date range
get
Dashboard of Threat Models
get
Threats
Retrieves total threat count
get
Retrieves all threats for the given parent record
get
Retrieves short version of all threats
get
Retrieves short version of all threats by parent module
get
Graphs threats based on the provided column and grouping config
post
Graphs threats based on the provided date range
get
Filters threats based on the specified criteria
post
Retrieves all threats based on the custom field criteria provided
get
Creates a new threat
post
Updates a threat record
put
Deletes a threat
del
Retrieves a threat
get
Run the specified report for issues
get
Graphs Issues schedule based on date range
get
Gets data for threats card on main dashboard
get
Graphs complete/incomplete threats for main dashboard
get
Dashboard of Issues
get
Graphs threats based on the provided column and grouping config (parent module)
get
ThreatScenario
Retrieves all threat scenarios records for a parent record
get
Get all risks for a given threat scenario.
get
Creates a new threat scenario record
post
Updates a threat scenario record
put
Deletes a threat scenario record
del
Retrieves a Threat Scenario Record
get
TimeTravel
Get all time travel records by parent record and module.
get
Finds a specific time travel record
get
Return the MD5 hash of the given time travel record.
get
Return the hash checks for the given time travel record.
get
Tools
Retrieves all tools for a parent record
get
Creates a new Tool
post
Updates a Tool record
put
Deletes a tool
del
Retrieves a Tool
get
UserGroups
Creates a new user group
post
Updates a groups record
put
Get a unique user group based on its primary key.
get
Deletes user group
del
Get the list of users in the specified group ID.
get
Get the list of groups for a given user ID.
get
Filters user groups based on the specified criteria
get
Volpe
Authorizes RegScale to communicate with the specified Volpe tenant (setup in the Admin panel->Integrations)
get
Retrieves the system list in VITG for your organization
get
Retrieves the document list in VITG for a given system
get
Submits a system security plan to VITG for processing
post
Submit an OSCAL artifact for NIST OSCAL CLI validation via the external API.
post
Submit an OSCAL artifact for FedRAMP Schematron validation via the external API.
post
Convert an OSCAL JSON or YAML artifact to XML using NIST OSCAL-CLI via the external API.
post
Convert a raw XML,JSON or YAML artifact to raw target format specified. Notice: This version does NOT support .xlst transformations. For OSCAL specific transformations for your artifact use: ConvertToXML
post
Vulnerability
Get all vulnerabilities for a given scan ID.
get
Get all vulnerabilities for a given parent record ID by module.
get
Get the count of vulnerabilities for the caller's tenant.
get
Create a new vulnerability.
post
Update a vulnerability.
put
Create new vulnerability records as a batch.
post
Get a vulnerability by its ID.
get
Get a vulnerability by its UUID.
get
Get the list of assets for a given vulnerability associated with a module
get
Get the list of vulnerabilities based on the given parameterse.
get
Get information about a given vulnerability via the NIST National Vulnerability Database (NVD) API.
get
Get the list of CVEs for the given security plan, grouped by title and severity.
get
VulnerabilityMapping
Get the count of vulnerability mappings for the caller's tenant.
get
Create a new vulnerability mapping.
post
Update a vulnerability mapping
put
Create new vulnerability mapping records as a batch.
post
Get a vulnerability mapping by its ID.
get
Get vulnerability mappings by vulnerability ID.
get
Get vulnerability mappings by asset ID.
get
Get vulnerability mappings by issue ID.
get
Find vulnerability mappings by Scan ID.
get
Delete a vulnerability mapping.
del
Wayfinder
Get a list of headers (metadata) about available Wayfinders.
get
Create a new Wayfinder.
post
Create a Wayfinder based on given parent information and name of the file where the Wayfinder definition is stored.
post
Delete a Wayfinder.
del
Get Wayfinders for a given record.
get
Get wayfinder instance for a given record.
get
Update an existing wayfinder instance.
put
Webhook
Registers new web hooks that listen to published events. If event type matches, then fire the webhook endpoint. Webhooks marked persistent will be saved to the db and will be started when the application starts.
post
/api/webhooks/{id}
put
/api/webhooks/{id}
del
/api/webhooks/list
get
/api/webhooks/subscription/enable/{id}
put
/api/webhooks/subscription/disable/{id}
put
WorkflowAction
Creates a new workflow action assignment record
post
Retrieves all available workflow actions for the given module
get
Deletes a workflow action assignment record
del
Retrieves a workflow action record
get
Retrieves a workflow action record by Parent Id and Module
get
Retrieves a workflow action record by Workflow Instance ID #
get
WorkflowInstances
Filters workflow instance steps by their module instance that created the workflow
get
Retrieves total workflow instances count
get
Retrieves # of active workflow instances
get
Retrieves total workflow instances by status
get
Retrieves open workflows for the provided user that were started within the provided days before today's date
get
Filters Workflow Instance Steps based on the specified criteria
post
Filters workflow instances based on the specified criteria
get
Filters workflow instances by user
get
Approve workflow step
put
Updates a workflow instance record
put
Create workflow instance from module
post
Create workflow instance based on a provided set of custom steps. The first parameter is a list of steps where you can set the WorkflowInstanceId to zero as it will create a new workflow instance with these steps and then attach it to the record provide by the module and parentId parameters.
post
Create workflow instance based on the provided manager or users
post
Create workflow instance based on the provided manager or users
post
Reject workflow step
put
Create workflow instance from template
post
Creates a new workflow instance
post
Updates a workflow instance record
put
Deletes a workflow instance
del
Retrieves a workflow instance
get
WorkflowInstanceSteps
Retrieves all workflow instance steps for the provided workflow instance
get
Filters Workflow Instance Steps based on the specified criteria
post
Filters workflow instance steps by their parent
get
Creates a new workflow instance step
post
Updates a workflow instance step record
put
Retrieves a workflow instance step
get
WorkflowTemplates
Retrieves total count of workflow templates
get
Retrieves workflow templates by the given module
get
Retrieves workflow analytics on execution time
get
Filters workflow templates based on the specified criteria
get
Creates a new workflow template
post
Updates a workflow template record
put
Retrieves a workflow template by workflow template ID
get
WorkflowTemplateSteps
Retrieves all workflow template steps for the provided workflow template
get
Filters workflow template steps by their parent
get
Creates a new workflow template step
post
Updates a workflow template step record
put
Removes a workflow template step record and updates the template
put
Reorders a workflow template's steps
post
Retrieves a workflow template step
get
Powered by
Fetches the list of modules (name, system information, and id)
get
https://{baseUrl}/api/modules
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
your-instance.regscale.co
/api/modules
RESPONSE
Click
Try It!
to start a request and see the response here!
