Corva Platform API
The Corva Platform API serves platform entities and their relationships — wells, rigs, drillout units, programs, pads and frac fleets, together with users, dashboards, alerts, apps, tasks, files and API keys. It is where an integration resolves the asset_id that every Data API query filters on: read attributes.asset_id from GET /v2/wells, or the top-level id from GET /v2/assets. It publishes a Swagger 2.0 contract (version v2.222.1) with 513 paths, 771 operations and 574 definitions, rendered by Swagger UI.
Corva Platform API is one of 3 APIs that Corva AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Platform API, Assets, Wells, Rigs, and Swagger. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 771 operations across 513 paths, organized into 89 resource areas, and defines 574 schemas. It is described by OpenAPI 2.0, at version v2.222.1.
Requests are made against the base URL https://api.corva.ai.
771 operations
513 paths
574 schemas
110 DELETE320 GET107 PATCH222 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Corva Platform API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as authorization (api_key).
By default, every request must be authenticated.
Paths & Operations 771
Across 513 paths, the API surfaces 771 operations — 110 DELETE, 320 GET, 107 PATCH, 222 POST, 12 PUT. They span 89 resource areas, including AbilityCheck, Feed, Alerts, AlertDefinitions, AlertGroups, AlertRBAC, AlertTags, AlertWorkflows, and 81 more. Each is listed below with its method, path, parameters, and response codes.
AbilityCheck 2
Check abilities for user
GET
v2/ability_check/check_feature
Check feature status for user
GET
v2/ability_check/check_permission
Check permission status for user
Feed 5
Manage Feed
GET
/v2/activities
List activities
POST
/v2/activities
Create an activity
GET
/v2/activities/{id}
Show activity
PATCH
/v2/activities/{id}
Update an activity
DELETE
/v2/activities/{id}
Delete an activity
Alerts 47
Manage Alerts
GET
/v2/alerts/{alert_id}/activities
List Alert Activities
GET
/v1/alerts/{alert_id}/comments/
List comments for alert
POST
/v1/alerts/{alert_id}/comments/
Create a comment for alert
GET
/v1/alerts/{alert_id}/comments/{id}
Show comment for alert
PATCH
/v1/alerts/{alert_id}/comments/{id}
Update an alert comment
DELETE
/v1/alerts/{alert_id}/comments/{id}
Delete an alert comment
GET
/v1/alerts/{alert_id}/comments/{comment_id}/likes
List likes for alert's comment
POST
/v1/alerts/{alert_id}/comments/{comment_id}/likes/toggle
Toggle a like for alert's comment
GET
/v2/alerts/{alert_id}/comments
List Alert Comments
POST
/v2/alerts/{alert_id}/comments
Create Alert Comment
GET
/v1/alerts/{alert_id}/likes
List likes for alert
POST
/v1/alerts/{alert_id}/likes/toggle
Toggle a like for alert
GET
/v1/alerts/definitions
List Alert Definitions
GET
/v1/alerts/definitions/context
Gather Alert Definition Context
POST
/v1/alerts/definitions/trigger
Trigger Alert
POST
/v1/alerts/definitions/close
Close Open Alerts
POST
/v1/alerts/definitions/{alert_definition_id}/check
Check Alert Definition in point of time
GET
/v1/alerts/definitions/templates/{template_type}
List Alert Definition Templates
POST
/v1/alerts/definitions/{id}/save_as_template
Save Alert Definition as Library Template
POST
/v1/alerts/definitions/{alert_definition_id}/enable
Enable Alert Definition Template
POST
/v1/alerts/definitions/{alert_definition_id}/disable
Disable Alert Definition Template
GET
/v2/alerts/metrics
Alert Occurrence Metrics
GET
/v2/alerts/notifications/types
List Alert Notification Types
GET
/v2/alerts/{alert_id}/occurrences
List Alert Occurrences
POST
/v2/alerts/{alert_id}/occurrences/{id}/classify
Classify an Alert Occurrence
GET
/v2/alerts/occurrences/series
Alert Occurrence Time-Series
GET
/v1/alerts
List Alerts
GET
/v1/alerts/{id}
Get Alert
POST
/v1/alerts/{alert_id}/acknowledge
Add acknowledgement to alert
POST
/v1/alerts/acknowledge
Bulk acknowledge multiple alerts
POST
/v1/alerts/{alert_id}/classify
Add alertclassification to alert
POST
/v1/alerts/{alert_id}/transition
Transition alert status
POST
/v1/alerts/{alert_id}/escalate
Escalate alert to specific users
POST
/v1/alerts/{alert_id}/deescalate
Close active escalation on alert
GET
/v1/alerts/totals
Alerts Counts
GET
/v1/alerts/details
Alerts Details for given period of time
GET
/v2/alerts
List Alerts (V2)
POST
/v2/alerts/{id}/acknowledge
Acknowledge Alert (V2)
GET
/v2/alerts/{id}
Get Alert (V2)
DELETE
/v2/alerts/{id}
Delete Alert (V2)
POST
/v2/alerts/{id}/classify
Classify Alert (V2)
POST
/v2/alerts/{alert_id}/deescalate
Close active escalation on alert (V2)
POST
/v2/alerts/{id}/transition
Transition Alert status (V2)
POST
/v2/alerts/{id}/check
Check Alert notification rules (V2)
POST
/v2/alerts/{id}/escalate
Escalate Alert (V2)
GET
/v2/alerts/totals
Alert Totals (V2)
GET
/v2/alerts/details
List Alert Details (V2)
AlertDefinitions 18
Alert definition management (V2)
GET
/v2/alerts/definitions
List Alert Definitions
POST
/v2/alerts/definitions
Create Alert Definition
GET
/v2/alerts/definitions/templates/{template_type}
List Alert Definition Templates
GET
/v2/alerts/definitions/{id}
Get Alert Definition
PATCH
/v2/alerts/definitions/{id}
Update Alert Definition
DELETE
/v2/alerts/definitions/{id}
Delete Alert Definition
POST
/v2/alerts/definitions/{id}/copy
Copy Alert Definition
POST
/v2/alerts/definitions/{id}/apply
Apply Library Template To Alert Group
POST
/v2/alerts/definitions/{id}/refresh
Refresh Alert Definition From Library
GET
/v2/alerts/definitions/{id}/refresh_preview
Preview A Library Refresh
POST
/v2/alerts/definitions/{id}/subscribe
Subscribe to Alert Definition
POST
/v2/alerts/definitions/{id}/unsubscribe
Unsubscribe from Alert Definition
GET
/v2/alert_groups/{alert_group_id}/alert_definitions
List an Alert Group's Definitions
POST
/v2/alert_groups/{alert_group_id}/alert_definitions
Assign an Alert Definition to a Group
DELETE
/v2/alert_groups/{alert_group_id}/alert_definitions/{id}
Unassign an Alert Definition from a Group
POST
/v2/alert_groups/{alert_group_id}/alert_definitions/bulk_create
Bulk Assign Alert Definitions to a Group
DELETE
/v2/alert_groups/{alert_group_id}/alert_definitions/bulk_destroy
Bulk Unassign Alert Definitions from a Group
PUT
/v2/alert_groups/{alert_group_id}/alert_definitions/bulk_replace
Replace an Alert Group's Definitions
AlertGroups 23
Alert group management - team-scoped alert configurations
GET
/v2/alert_groups
List Alert Groups
POST
/v2/alert_groups
Create Alert Group
GET
/v2/alert_groups/{id}
Get Alert Group
PATCH
/v2/alert_groups/{id}
Update Alert Group
DELETE
/v2/alert_groups/{id}
Delete Alert Group
POST
/v2/alert_groups/{id}/merge
Merge Alert Group
GET
/v2/alert_groups/{alert_group_id}/alert_group_users
List Group Members
POST
/v2/alert_groups/{alert_group_id}/alert_group_users
Add Member to Group
DELETE
/v2/alert_groups/{alert_group_id}/alert_group_users/{id}
Remove Member from Group
GET
/v2/alert_groups/{alert_group_id}/alert_group_scopes
List Group Scopes
POST
/v2/alert_groups/{alert_group_id}/alert_group_scopes
Add Scope Target to Group
DELETE
/v2/alert_groups/{alert_group_id}/alert_group_scopes/{id}
Remove Scope Target from Group
GET
/v2/alert_groups/{alert_group_id}/alert_group_configurations
List Group Configurations
POST
/v2/alert_groups/{alert_group_id}/alert_group_configurations
Create Group Configuration
PATCH
/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}
Update Group Configuration
DELETE
/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}
Delete Group Configuration
POST
/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_create
Bulk Add Members to Group
DELETE
/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_destroy
Bulk Remove Members from Group
POST
/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_create
Bulk Add Scope Targets to Group
DELETE
/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_destroy
Bulk Remove Scope Targets from Group
PUT
/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_replace
Replace Group Scope Targets
POST
/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_create
Bulk Create Group Configurations
DELETE
/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_destroy
Bulk Delete Group Configurations
AlertRBAC 9
GET
/v2/alert_abilities
List Assignable Alert Abilities
GET
/v2/companies/{company_id}/alert_roles
List Alert Roles
POST
/v2/companies/{company_id}/alert_roles
Create Alert Role
GET
/v2/companies/{company_id}/alert_roles/{id}
Get Alert Role
PATCH
/v2/companies/{company_id}/alert_roles/{id}
Update Alert Role
DELETE
/v2/companies/{company_id}/alert_roles/{id}
Delete Alert Role
PUT
/v2/companies/{company_id}/alert_roles/{id}/abilities
Replace Alert Role Abilities
POST
/v2/companies/{company_id}/alert_rbac/enable
Enable Alert RBAC
POST
/v2/companies/{company_id}/alert_rbac/disable
Disable Alert RBAC
AlertTags 4
GET
/v2/alert_tags
List Alert Tags
POST
/v2/alert_tags
Create Alert Tag
PATCH
/v2/alert_tags/{id}
Update Alert Tag
DELETE
/v2/alert_tags/{id}
Delete Alert Tag
AlertWorkflows 4
Alert status workflow definitions (global and company-specific)
GET
/v1/alert_workflows
List Alert Workflows
GET
/v1/alert_workflows/{id}
Get Alert Workflow
GET
/v2/alert_workflows
List Alert Workflows
GET
/v2/alert_workflows/{id}
Get Alert Workflow
AuthenticationPlatforms 2
Read authentication platforms (broker tenants) used for SSO. Read-only; managed in ActiveAdmin.
GET
/v2/authentication_platforms
List authentication platforms
GET
/v2/authentication_platforms/{id}
Show authentication platform
AppReviews 3
Manage AppsReviews
GET
/v2/app_reviews
List accesible App Reviews
POST
/v2/app_reviews/{id}/approve
Approve App Review
POST
/v2/app_reviews/{id}/decline
Approve App Review
Assets 96
Manage company assets: Programs, Pads, Rigs, Wells, Frac Fleets, and Wirelines
GET
/v2/favorites
List favorites
GET
/v2/assets
List assets
GET
/v2/assets/{id}
Get asset by ID
GET
/v2/assets/{id}/settings
Get asset settings
GET
/v2/assets/{id}/type_wells
List type well assets
POST
/v2/assets/{id}/type_well
Create a new typewell
DELETE
/v2/assets/{id}/type_wells/{type_well_id}
Delete typewell
GET
/v2/assets/{id}/reruns
Return reruns for the asset
GET
/v2/assets/{id}/ancestor_ids
Return the ancestorids for the asset
POST
/v2/assets/resolve
Resolve old-style assets to new-style assets
GET
/v2/assets/autocomplete
Return autocompletion tokens
GET
/v2/programs
List programs
POST
/v2/programs
Create a program
GET
/v2/programs/{id}
Get a single program
PATCH
/v2/programs/{id}
Update a program
DELETE
/v2/programs/{id}
Delete a program
GET
/v2/programs/clusters
Get programs clustered based on their location
GET
/v2/pads
List pads
POST
/v2/pads
Create a pad
GET
/v2/pads/{id}
Get a single pad
PATCH
/v2/pads/{id}
Update a pad
DELETE
/v2/pads/{id}
Delete a pad
POST
/v2/pads/{id}/frac_fleets
Add a frac fleet to a pad
DELETE
/v2/pads/{pad_id}/frac_fleets/{id}
Delete a frac fleet from a pad
GET
/v2/pads/{pad_id}/app_wells
Retrieve wells and app stream details for a pad filtered by app.sourcetype
GET
/v2/pads/{id}/wells
Retrieve well and app stream details for a pad
POST
/v2/pads/{id}/wells
Add a well to a pad
DELETE
/v2/pads/{pad_id}/wells/{id}
Delete a well from a pad
POST
/v2/pads/{id}/active_wells
Add an active well to a pad
DELETE
/v2/pads/{pad_id}/active_wells/{id}
Delete an active well from a pad
GET
/v2/pads/clusters
Get pads clustered based on their location
GET
/v2/rigs
List rigs
POST
/v2/rigs
Create a rig
GET
/v2/rigs/{id}
Get a single rig
PATCH
/v2/rigs/{id}
Update a rig
DELETE
/v2/rigs/{id}
Delete a rig
GET
/v2/rigs/clusters
Get rigs clustered based on their location
GET
/v2/rigs/{rig_id}/active_well/well_cache
Get wellcache record for the active well on the rig
GET
/v2/drillout_units
List drillout units
POST
/v2/drillout_units
Create a drillout unit
GET
/v2/drillout_units/{id}
Get a single drillout unit
PATCH
/v2/drillout_units/{id}
Update a drillout unit
DELETE
/v2/drillout_units/{id}
Delete a drillout unit
GET
/v2/drillout_units/clusters
Get drillout units clustered based on their location
GET
/v2/wells
List wells
POST
/v2/wells
Create a well
GET
/v2/wells/{id}
Get a single well
PATCH
/v2/wells/{id}
Update a well
DELETE
/v2/wells/{id}
Delete a well
GET
/v2/wells/clusters
Get wells clustered based on their location
GET
/v2/frac_fleets
List frac fleets
POST
/v2/frac_fleets
Create a frac fleet
GET
/v2/frac_fleets/{id}
Get a single frac fleet
PATCH
/v2/frac_fleets/{id}
Update a frac fleet
DELETE
/v2/frac_fleets/{id}
Delete a frac fleet
POST
/v2/frac_fleets/{id}/pads
Add one or more pads to a frac fleet, or set the current pad
DELETE
/v2/frac_fleets/{frac_fleet_id}/pads/{id}
Delete a pad from a frac fleet
GET
/v2/frac_fleets/{frac_fleet_id}/active_wells/well_cache
Get wellcache records for the active wells on the frac fleet
GET
/v2/frac_fleets/clusters
Get frac fleets clustered based on their location
GET
/v2/wirelines
List wirelines
POST
/v2/wirelines
Create a wireline
GET
/v2/wirelines/{id}
Get a single wireline
PATCH
/v2/wirelines/{id}
Update a wireline
DELETE
/v2/wirelines/{id}
Delete a wireline
GET
/v2/rig_templates
List rig templates
POST
/v2/rig_templates
Create a rig template
GET
/v2/rig_templates/aggregated_values
Get aggregated values from rig template items
GET
/v2/rig_templates/{id}
Show Rig Template
PATCH
/v2/rig_templates/{id}
Update a Rig Template
DELETE
/v2/rig_templates/{id}
Delete a Rig Template
GET
/v2/rig_template_categories
List rig template categories
POST
/v2/rig_template_categories
Create a rig template category
GET
/v2/rig_template_categories/{id}
Show Rig Template Category
PATCH
/v2/rig_template_categories/{id}
Update a Rig Template Category
DELETE
/v2/rig_template_categories/{id}
Delete a Rig Template Category
GET
/v2/rig_templates/{rig_template_id}/rig_template_items
List items of rig template
POST
/v2/rig_templates/{rig_template_id}/rig_template_items
Create a rig template item
GET
/v2/rig_templates/{rig_template_id}/rig_template_items/{id}
Show Rig Template Item
PATCH
/v2/rig_templates/{rig_template_id}/rig_template_items/{id}
Update Rig Template Item
DELETE
/v2/rig_templates/{rig_template_id}/rig_template_items/{id}
Delete a Rig Template Item
GET
/v2/intervention_unit_templates
List intervention unit templates
POST
/v2/intervention_unit_templates
Create an intervention unit template
GET
/v2/intervention_unit_templates/aggregated_values
Get aggregated values from intervention unit template items
GET
/v2/intervention_unit_templates/{id}
Show an intervention unit template
PATCH
/v2/intervention_unit_templates/{id}
Update an intervention unit template
DELETE
/v2/intervention_unit_templates/{id}
Delete an intervention unit template
GET
/v2/intervention_unit_template_categories
List intervention unit template categories
POST
/v2/intervention_unit_template_categories
Create an intervention unit template category
GET
/v2/intervention_unit_template_categories/{id}
Show an intervention unit template category
PATCH
/v2/intervention_unit_template_categories/{id}
Update an intervention unit template category
DELETE
/v2/intervention_unit_template_categories/{id}
Delete an intervention unit template category
GET
/v2/intervention_unit_templates/{intervention_unit_template_id}/intervention_unit_template_items
List intervention unit template items
POST
/v2/intervention_unit_templates/{intervention_unit_template_id}/intervention_unit_template_items
Create an intervention unit template item
GET
/v2/intervention_unit_templates/{intervention_unit_template_id}/intervention_unit_template_items/{id}
Show an intervention unit template item
PATCH
/v2/intervention_unit_templates/{intervention_unit_template_id}/intervention_unit_template_items/{id}
Update an intervention unit template item
DELETE
/v2/intervention_unit_templates/{intervention_unit_template_id}/intervention_unit_template_items/{id}
Delete an intervention unit template item
Security 43
Manage security policies, permissions, and groups
GET
/v2/companies/{company_id}/authentication_schemas
List authentication schemas usable by the company
GET
/v2/companies/{company_id}/authentication_schemas/{id}
Show an authentication schema
DELETE
/v2/companies/{company_id}/authentication_schemas/{id}
Delete an authentication schema
GET
/v2/companies/{company_id}/company_domains
List company domains
POST
/v2/companies/{company_id}/company_domains
Create a company domain
GET
/v2/companies/{company_id}/company_domains/{id}
Show a company domain
PATCH
/v2/companies/{company_id}/company_domains/{id}
Update a company domain
DELETE
/v2/companies/{company_id}/company_domains/{id}
Delete a company domain
GET
/v2/groups
List Groups
POST
/v2/groups
Create a Group
GET
/v2/groups/{id}
Show Group
PATCH
/v2/groups/{id}
Update a Group
DELETE
/v2/groups/{id}
Delete a Group
GET
/v2/groups/{id}/users
Show Users for a given Group
GET
/v2/users/{user_id}/groups
List Groups for User
POST
/v2/users/{user_id}/groups
Add Group to User
DELETE
/v2/users/{user_id}/groups/{id}
Remove a Group from User
POST
/v2/groups/{group_id}/assign_users
Assign users to group
POST
/v2/groups/copy_users
Copy users from one group to another
GET
/v2/security_policies
List Security Policies
GET
/v2/security_policies/{id}
Show Security Policy
GET
/v2/companies/{company_id}/security_policies
List Company Security Policies
POST
/v2/companies/{company_id}/security_policies
Create a Company Security Policy
GET
/v2/companies/{company_id}/security_policies/{id}
Show Company Security Policy
PATCH
/v2/companies/{company_id}/security_policies/{id}
Update a Company Security Policy
DELETE
/v2/companies/{company_id}/security_policies/{id}
Delete a Company Security Policy
GET
/v2/companies/{company_id}/authentication_schema_contexts
List authentication-schema contexts touching a company
GET
/v2/users/{user_id}/permissions
List Permissions
POST
/v2/users/{user_id}/permissions
Create a Permission
GET
/v2/users/{user_id}/permissions/{id}
Show Permission
PATCH
/v2/users/{user_id}/permissions/{id}
Update a Permission
DELETE
/v2/users/{user_id}/permissions/{id}
Delete a Permission
POST
/v2/users/{user_id}/permissions/bulk_create
Create Multiple Permissions with list of abilities
DELETE
/v2/groups/{user_id}/permissions/bulk_destroy
Delete Multiple Permissions
GET
/v2/groups/{group_id}/permissions
List Permissions
POST
/v2/groups/{group_id}/permissions
Create a Permission
GET
/v2/groups/{group_id}/permissions/{id}
Show Permission
PATCH
/v2/groups/{group_id}/permissions/{id}
Update a Permission
DELETE
/v2/groups/{group_id}/permissions/{id}
Delete a Permission
GET
/v2/groups/{group_id}/permissions/grouped
List Grouped Permissions
GET
/v2/users/{user_id}/permissions/grouped
List Grouped Permissions
POST
/v2/groups/{group_id}/permissions/bulk_create
Create Multiple Permissions with list of abilities
DELETE
/v2/groups/{group_id}/permissions/bulk_destroy
Delete Multiple Permissions
DashboardAppAnnotations 16
Manage annotations to applications on user dashboards
GET
/v2/dashboard_app_annotations/{app_annotation_id}/comments/
List comments for app annotation
POST
/v2/dashboard_app_annotations/{app_annotation_id}/comments/
Create a comment for app annotation
GET
/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}
Show comment for app annotation
PATCH
/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}
Update an app annotation comment
DELETE
/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}
Delete an app annotation comment
GET
/v2/dashboard_app_annotations/{app_annotation_id}/comments/{comment_id}/likes
List likes for app annotation's comment
POST
/v2/dashboard_app_annotations/{app_annotation_id}/comments/{comment_id}/likes/toggle
Toggle a like for app annotation's comment
GET
/v2/dashboard_app_annotations/{app_annotation_id}/likes
List likes for app annotation
POST
/v2/dashboard_app_annotations/{app_annotation_id}/likes/toggle
Toggle a like for app annotation
GET
/v2/dashboard_app_annotations
List annotations for app-asset combination
POST
/v2/dashboard_app_annotations
Create an app annotation
GET
/v2/dashboard_app_annotations/{id}
Show app annotation
PATCH
/v2/dashboard_app_annotations/{id}
Update an app annotation
DELETE
/v2/dashboard_app_annotations/{id}
Delete an app annotation
GET
/v2/dashboard_app_annotations/{id}/close
Closes app annotation for curent user, returns new last annotation for user and app-asset combination
GET
/v2/dashboard_app_annotations/last_annotations
Returns last app annotations for current user and dashboard or dashboard-asset combination
Dashboards 37
Manage your dashboards, which contain one or more visualization apps
POST
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps
Create a dashboard app with app name and category
POST
/v1/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/bulk_create
Bulk create dashboardapps for different assetids
PUT
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/batch_update
Update all dashboard apps in a dashboard
GET
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}
Show dashboard app
PATCH
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}
Update a dashboard app
DELETE
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}
Delete a dashboard app
GET
/v2/users/{user_id}/dashboard_folders
List dashboard folders
POST
/v2/users/{user_id}/dashboard_folders
Create a dashboard folder
PATCH
/v2/users/{user_id}/dashboard_folders/{id}
Update a dashboard folder
DELETE
/v2/users/{user_id}/dashboard_folders/{id}
Delete a dashboard folder
GET
/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares
List dashboard shares in a dashboard folder for a user
POST
/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares
Add a dashboard share to a dashboard folder
PATCH
/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares/{id}
Update a dashboard share in a dashboard folder
DELETE
/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares/{id}
Remove a dashboard share from a dashboard folder
GET
/v2/dashboard_folder_shares
List dashboard folder shares
POST
/v2/dashboard_folder_shares
Create a dashboard folder share
PATCH
/v2/dashboard_folder_shares/{id}
Update a dashboard folder share
DELETE
/v2/dashboard_folder_shares/{id}
Delete a dashboard folder share
POST
/v2/dashboard_folder_shares/{id}/use
Use dashboard folder share for user
GET
/v1/users/{user_id}/dashboards
List dashboards for user
GET
/v1/users/{user_id}/dashboards/{id}
Get dashboard by ID
GET
/v2/users/{user_id}/dashboards
List dashboards
POST
/v2/users/{user_id}/dashboards
Create a dashboard
GET
/v2/users/{user_id}/dashboards/{id}
Show dashboard
PATCH
/v2/users/{user_id}/dashboards/{id}
Update a dashboard
DELETE
/v2/users/{user_id}/dashboards/{id}
Delete a dashboard
POST
/v2/users/{user_id}/dashboards/{id}/clone
Clone a dashboard
GET
/v2/dashboards/templates
Get template dashboards
POST
/v2/users/{user_id}/dashboards/{id}/use_template
Set dashboard apps and layout from a template dashboard
GET
/v2/dashboards
List all dashboards
GET
/v2/dashboards/{id}/available_timezones
List timezones for dashboard
GET
/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters
Get data filters for dashboard
POST
/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters
Create a data filter
POST
/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters#2
Update multiple data filters
GET
/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}
Show data filter
PATCH
/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}
Update a data filter
DELETE
/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}
Delete a data filter
Well Plan Checklists 2
Manage well plan checklists
GET
/v2/well_plan_checklists
List well plan checklists
GET
/v2/well_plan_checklists/{id}
Show well plan checklist
Well Plans 6
Manage well plans
GET
/v2/well_plans
List well plans
POST
/v2/well_plans
Create a well plan
POST
/v2/well_plans/copy
Copy data from one well plan into another
GET
/v2/well_plans/{id}
Show well plan
PATCH
/v2/well_plans/{id}
Update well plan
DELETE
/v2/well_plans/{id}
Delete well plan
Well Planning Dashboards 11
GET
/v2/well_planning_dashboards
List well planning dashboards
POST
/v2/well_planning_dashboards
Create a custom planning dashboard for a well
GET
/v2/well_planning_dashboards/{id_or_slug}
Show well planning dashboard
PATCH
/v2/well_planning_dashboards/{id_or_slug}
Update a well planning dashboard
DELETE
/v2/well_planning_dashboards/{id_or_slug}
Delete a well planning dashboard
POST
/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps
Create a dashboard app on a well planning dashboard
PUT
/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps
Batch update dashboard apps on a well planning dashboard
POST
/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/bulk_create
Bulk create dashboard apps on a well planning dashboard
GET
/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}
Show dashboard app on a well planning dashboard
PATCH
/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}
Update dashboard app on a well planning dashboard
DELETE
/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}
Delete dashboard app from a well planning dashboard
Data 7
Manage company data for all data collections
GET
/v1/data/{provider}/{dataset}
Retrieve records of data from a dataset
POST
/v1/data/{provider}/{dataset}
Save one or more records of data to a dataset
DELETE
/v1/data/{provider}/{dataset}
Delete selected data records from a dataset
GET
/v1/data/{provider}/{dataset}/{id}
Retrieve a single data record from a dataset
PATCH
/v1/data/{provider}/{dataset}/{id}
Update fields in a data record in a dataset
PUT
/v1/data/{provider}/{dataset}/{id}
Replace data record in a dataset
DELETE
/v1/data/{provider}/{dataset}/{id}
Delete a single data record from a dataset
Files 9
Manage file uploads and downloads
POST
/v1/file
Upload a file as form data
PUT
/v1/file
Update a file by S3 key
GET
/v1/file/sign
Returns a signed URL
GET
/v1/file/preview
Redirects user to the file via a generated download link
GET
/v1/file/download
Downloads a file
GET
/v1/file/download_link
Returns a URL where the file can be downloaded
DELETE
/v1/file/delete
Deletes a file
DELETE
/v2/files
Deletes a file
GET
/v2/files/url
Get signed URL for a file
WellView 9
WellView 3rd-Party integration
POST
/v2/integration/wellview/resolve
Resolve an asset based on an array of lookups
POST
/v2/integration/wellview/ingest
Send data into Corva for processing
GET
/v2/integration/wellview/bha
Retrieve Corva BHA/Drillstring data
GET
/v2/integration/wellview/frac
Retrieve Corva Fracking data
GET
/v2/integration/wellview/frac_stage_design
Retrieve Corva Frac Stage Design data
GET
/v2/integration/wellview/frac_stage_summary
Retrieve Corva Frac Stage Summary data
GET
/v2/integration/wellview/frac_stage_summary_calculated
Retrieve Corva Frac Stage Summary Calculated data
GET
/v2/integration/wellview/job_settings
Retrieve Corva Job Settings data
GET
/v2/integration/wellview/plugs
Retrieve Corva Plugs data
Users 31
User, API key, and session management
GET
/v1/.well-known/jwks.json
Get JWKS public keys
POST
/v1/user_token#1
Obtain user token via email + password authentication
POST
/v1/user_token#2
Obtain user token via Auth0 SSO authentication
POST
/v1/user_token#3
Obtain user token via email + password authentication with multi-factor authentication
POST
/v1/user_token#4
Refresh jwt token using refreshtoken
POST
/v1/sessions/verification/request
Request verification code
GET
/v1/sessions/schemas
Get available authentication schemas
GET
/v2/users
List Users
POST
/v2/users
Create a User
GET
/v2/users/{id}
Show User
PATCH
/v2/users/{id}
Update a User
DELETE
/v2/users/{id}
Delete a User
GET
/v2/users/export
Export users by company as csv
GET
/v2/users/streaks
User Streaks list
GET
/v2/users/{user_id}/settings
Get all settings for a user
POST
/v2/users/{user_id}/settings
Add settings for a user
GET
/v2/users/{user_id}/settings/{key}
Get a setting with a key
DELETE
/v2/users/{user_id}/settings/{key}
Delete a setting with a key
GET
/v2/users/{user_id}/identity_verifiers
List Identity Verifiers for a User
POST
/v2/users/{user_id}/identity_verifiers
Create Identity Verifier for a User
GET
/v2/users/{user_id}/identity_verifiers/{mode}
Show Specific Identity Verifier for a User
PATCH
/v2/users/{user_id}/identity_verifiers/{mode}
Update Specific Identity Verifier for a User
DELETE
/v2/users/{user_id}/identity_verifiers/{mode}
Delete Specific Identity Verifier for a User
GET
/v2/api_keys
List accessible API keys
POST
/v2/api_keys
Create an API key
GET
/v2/api_keys/current
Show current API key
GET
/v2/api_keys/{id}
Show API key
PATCH
/v2/api_keys/{id}
Update an API key
DELETE
/v2/api_keys/{id}
Delete an API key
POST
/v2/api_keys/{id}/approve
Approve and activate an API key
POST
/v2/api_keys/{id}/deactivate
Deactivate an API key
MessageProducer 1
Message Producer for apps
POST
/message_producer
Produce messages for sent data
Notifications 7
Manage Notifications
GET
/v1/notifications
List notifications for current user
POST
/v1/notifications/acknowledge
Acknowledge multiple notifications
POST
/v1/notifications/acknowledge_all
Acknowledge all notifications for current user
POST
/v1/notifications/{id}/acknowledge
List notifications for current user
GET
/v1/notifications/{id}
Show notification
PATCH
/v1/notifications/{id}
Update notification
GET
/v1/notifications/count/unread
Get the unread notification count for the current user
NotificationPolicies 5
GET
/v2/notification_policies
List Notification Policies
POST
/v2/notification_policies
Create Notification Policy
GET
/v2/notification_policies/{id}
Get Notification Policy
PATCH
/v2/notification_policies/{id}
Update Notification Policy
DELETE
/v2/notification_policies/{id}
Delete Notification Policy
Picklists 6
Manage picklists, which are lists of options (usually key/value pairs)
GET
/v2/picklists
List picklists
POST
/v2/picklists
Create a picklist
GET
/v2/picklists/{name}
Show a single picklist
PATCH
/v2/picklists/{name}
Update picklist
POST
/v2/picklists/{name}/items
Create a picklist item
DELETE
/v2/picklists/{name}/items/{id}
Delete a picklist item
Tasks 5
Trigger and check status for background tasks
POST
/v2/tasks
Create a new task
GET
/v2/tasks
List tasks for asset and application
GET
/v2/tasks/{id}
Show Task
PATCH
/v2/tasks/{id}
Update payload of a task. This endpoint can be used with an api key on a running task
PUT
/v2/tasks/{id}/{status}
Update task status
TaskSchedules 6
Create and manage cron-based task schedules
GET
/v2/task_schedules
List Task Schedules
POST
/v2/task_schedules
Create Task Schedule
GET
/v2/task_schedules/{id}
Get Task Schedule
PATCH
/v2/task_schedules/{id}
Partially Update Task Schedule
PUT
/v2/task_schedules/{id}
Update Task Schedule
DELETE
/v2/task_schedules/{id}
Delete Task Schedule
Apps 33
Manage Apps
GET
/v2/apps
List accessible apps
POST
/v2/apps
Create an app
GET
/v2/apps/{id}
Show app
PATCH
/v2/apps/{id}
Update an App
DELETE
/v2/apps/{id}
Delete an App
POST
/v2/apps/{id}/install
Install an app for your company
GET
/v2/apps/{app_id}/packages
See all packages for an app
GET
/v2/apps/{app_key}/packages
See all packages for an app
POST
/v2/apps/{app_id}/packages/upload
Upload a new package for an app
GET
/v2/apps/{app_id}/packages/{id}/download
Download the latest package for an app
GET
/v2/apps/{app_id}/packages/{id}
Show a specific packages for an app
PATCH
/v2/apps/{app_id}/packages/{id}
Update a package
DELETE
/v2/apps/{app_id}/packages/{id}
Delete a package
POST
/v2/apps/{app_key}/packages/upload
Upload a new package for an app
GET
/v2/apps/app_categories
List app categories
GET
/v2/apps/categories
List categories from look up table
GET
/v2/apps/featured
List featured & promoted apps
GET
/v2/apps/types
List app types
POST
/v2/apps/{app_id}/secrets
Create a secret parameter for an app
PUT
/v2/apps/{app_id}/secrets
Update secret parameter for an app
DELETE
/v2/apps/{app_id}/secrets
Delete secret parameter for an app
GET
/v2/apps/{app_id}/app_help_contents
List AppHelpContents
POST
/v2/apps/{app_id}/app_help_contents
Create an AppHelpContent
GET
/v2/apps/{app_id}/app_help_contents/{id}
Show AppHelpContent
PATCH
/v2/apps/{app_id}/app_help_contents/{id}
Update an AppHelpContent
DELETE
/v2/apps/{app_id}/app_help_contents/{id}
Delete an AppHelpContent
GET
/v2/apps/{app_id}/app_help_contents/signed_url
Get signedurl for AppHelpContent
POST
/v2/apps/{app_id}/app_error_alerts
Create an AppErrorAlert
GET
/v2/apps/{app_id}/app_error_alerts
Show AppErrorAlert
PATCH
/v2/apps/{app_id}/app_error_alerts
Update an AppErrorAlert
DELETE
/v2/apps/{app_id}/app_error_alerts
Delete an AppErrorAlert
POST
/v2/apps/{app_id}/app_error_alerts/subscribe
Subscribe a user to AppErrorAlert
POST
/v2/apps/{app_id}/app_error_alerts/unsubscribe
Unsubscribe a user from AppErrorAlert
AppDatasets 4
Manage App Datasets
GET
/v2/apps/{app_id}/app_datasets
List appdatasets for app
POST
/v2/apps/{app_id}/app_datasets
Create an AppDataset
DELETE
/v2/apps/{app_id}/app_datasets/{app_dataset_id}
Delete an AppDataset
PATCH
/v2/apps/{app_id}/app_datasets/mark_followable
Mark an AppDataset as followable
AppLogs 3
GET
/v2/apps/{app_id}/app_logs
List log streams for app
GET
/v2/apps/{app_id}/app_logs/events/{log_stream}
List events for log stream
GET
/v2/apps/{app_id}/app_logs/search
Search log events
AppTypes 3
GET
/v2/app_types
List AppTypes
GET
/v2/app_types/{id}
Show AppType
PATCH
/v2/app_types/{id}
Update an AppType
AppSettingsTemplates 9
GET
/v2/apps/{app_key}/app_settings_templates
List accesible app settings templates
POST
/v2/apps/{app_key}/app_settings_templates
Create an app settings template
GET
/v2/apps/{app_key}/app_settings_templates/{id}
Show app
PATCH
/v2/apps/{app_key}/app_settings_templates/{id}
Update an AppSettingsTemplate
DELETE
/v2/apps/{app_key}/app_settings_templates/{id}
Delete an AppSettingsTemplate
POST
/v2/apps/{app_key}/app_settings_templates/{id}/share
Share an AppSettingsTemplate
POST
/v2/apps/{app_key}/app_settings_templates/{id}/unshare
Unshare an AppSettingsTemplate
POST
/v2/apps/{app_key}/app_settings_templates/{id}/copy
Copy user's own or shared AppSettingsTemplate
POST
/v2/apps/{app_key}/app_settings_templates/{id}/publish
Publish a AppSettingsTemplate as a company template. This'll create a copy of the template
AppStreamTemplate 5
GET
/v2/app_stream_templates
List accessible app stream templates
POST
/v2/app_stream_templates
Create an app stream template
GET
/v2/app_stream_templates/{id}
Show app stream template
PATCH
/v2/app_stream_templates/{id}
Update an AppStreamTemplate
DELETE
/v2/app_stream_templates/{id}
Delete an AppStreamTemplate
AppStreamTemplateApp 3
POST
/v2/app_stream_templates/{id}/add_app
Add AppStreamTemplateApp to AppStreamTemplate
POST
/v2/app_stream_templates/{app_stream_template_id}/update_app/{id}
Update AppStreamTemplateApp
DELETE
/v2/app_stream_templates/{app_stream_template_id}/remove_app/{id}
Remove AppStreamTemplateApp from AppStreamTemplate
DatasetTypes 3
GET
/v2/dataset_types
List DatasetTypes
GET
/v2/datset_types/{id}
Show DatasetType
PATCH
/v2/datset_types/{id}
Update an DatasetType
Documents 10
GET
/v2/documents
List documents
POST
/v2/documents
Create a document
GET
/v2/documents/{id}
Show Document
PATCH
/v2/documents/{id}
Update a Document
DELETE
/v2/documents/{id}
Delete a Document
GET
/v2/documents/{document_id}/document_sections
List sections of document
POST
/v2/documents/{document_id}/document_sections
Create a document section
GET
/v2/documents/{document_id}/document_sections/{id}
Show Document Section
PATCH
/v2/documents/{document_id}/document_sections/{id}
Update Document Section
DELETE
/v2/documents/{document_id}/document_sections/{id}
Delete a Document Section
Tiers 5
GET
/v2/tiers
List Tiers
POST
/v2/tiers
Create a Tier
GET
/v2/tiers/{id}
Show Tier
PATCH
/v2/tiers/{id}
Update a Tier
DELETE
/v2/tiers/{id}
Delete a Tier
ProductSubscriptions 8
GET
/v2/product_subscriptions
List Product Subscriptions
POST
/v2/product_subscriptions
Create a Product Subscription
GET
/v2/product_subscriptions/{uuid}
Show Product Subscription
PATCH
/v2/product_subscriptions/{uuid}
Update a Product Subscription
DELETE
/v2/product_subscriptions/{uuid}
Delete a Product Subscription
POST
/v2/product_subscriptions/{uuid}/cancel
Cancel a Product Subscription
POST
/v2/product_subscriptions/{id}/approve
Approve a Product Subscription
POST
/v2/product_subscriptions/{id}/deny
Deny a Product Subscription
PlatformSubscriptions 9
GET
/v2/platform_subscriptions
List Platform Subscriptions
POST
/v2/platform_subscriptions
Create a Platform Subscription
GET
/v2/platform_subscriptions/{uuid}
Show Platform Subscription
PATCH
/v2/platform_subscriptions/{uuid}
Update a Platform Subscription
DELETE
/v2/platform_subscriptions/{uuid}
Delete a Platform Subscription
POST
/v2/platform_subscriptions/{uuid}/cancel
Cancel a Platform Subscription
POST
/v2/platform_subscriptions/{id}/approve
Approve a Platform Subscription
POST
/v2/platform_subscriptions/{id}/deny
Deny a Platform Subscription
POST
/v2/platform_subscriptions/{id}/resume
Resume a Platform Subscription
ProvisioningSubscriptions 10
GET
/v2/provisioning_subscriptions
List Provisioning Subscriptions
POST
/v2/provisioning_subscriptions
Create a Provisioning Subscription
GET
/v2/provisioning_subscriptions/{uuid}
Show Provisioning Subscription
PATCH
/v2/provisioning_subscriptions/{uuid}
Update a Provisioning Subscription
DELETE
/v2/provisioning_subscriptions/{uuid}
Delete a Provisioning Subscription
POST
/v2/provisioning_subscriptions/{uuid}/cancel
Cancel a Provisioning Subscription
POST
/v2/provisioning_subscriptions/{id}/approve
Approve a Provisioning Subscription
POST
/v2/provisioning_subscriptions/{id}/deny
Deny a Provisioning Subscription
POST
/v2/provisioning_subscriptions/{id}/resume
Resume a Provisioning Subscription
GET
/v2/provisioning_subscriptions/{id}/app_streams
Show AppStream info for a Provisioning Subscription
PurchaseSubscriptions 4
GET
/v2/purchase_subscriptions
List Purchase Subscriptions
POST
/v2/purchase_subscriptions/{uuid}/cancel
Cancel a Purchase Subscription
GET
/v2/purchase_subscriptions/{uuid}
Show Purchase Subscription
PATCH
/v2/purchase_subscriptions/{uuid}
Update a Purchase Subscription
SubscriptionFeatures 2
GET
/v2/subscription_features
List Subscription Features
GET
/v2/subscription_features/{id}
Show Subscription Feature
ApiKey 8
POST
/v2/subscriptions_token
Create a subscriptions service token
GET
/v2/api_keys_management
List accessible API keys
POST
/v2/api_keys_management
Create an API key
GET
/v2/api_keys_management/{id}
Show API key
PATCH
/v2/api_keys_management/{id}
Update an API key
DELETE
/v2/api_keys_management/{id}
Delete an API key
POST
/v2/api_keys_management/{id}/activate
Approve and Activate an API key
POST
/v2/api_keys_management/{id}/deactivate
Deactivate an API key
WellCache 1
GET
/v1/data/corva/well_cache
List WellCache Records
BlacklistedDatasets 4
GET
/v2/groups/{group_id}/blacklisted_datasets
List of blacklisted datasets
POST
/v2/groups/{group_id}/blacklisted_datasets
Create BlacklistedDataset
POST
/v2/groups/{group_id}/blacklisted_datasets/bulk_create
Create many BlacklistedDatasets
DELETE
/v2/groups/{group_id}/blacklisted_datasets/{id}
Delete a blacklisted dataset
App 2
GET
/v2/apps/{app_id}/metrics
Metric statistics for a given App
GET
/v2/app_metrics/for_selected_apps
Metric statistics for the selected Apps
AppAssets 1
GET
/v2/apps/{app_id}/assets
Retrieve app assets
PackageReviews 5
GET
/v2/package_reviews
List PackageReviews
POST
/v2/package_reviews
Create a PackageReview
GET
/v2/package_reviews/{id}
Show PackageReview
PATCH
/v2/package_reviews/{id}
Update a PackageReview
DELETE
/v2/package_reviews/{id}
Cancel a PackageReview
AppPurchases 6
GET
/v2/app_purchases
List of app purchases
POST
/v2/app_purchases
Create a App Purchase
GET
/v2/app_purchases/{id}
Show app purchase
POST
/v2/app_purchases/{id}/approve
Approve app purchase
POST
/v2/app_purchases/{id}/deny
Deny app purchase
POST
/v2/app_purchases/{id}/resume
Resume a App Purchase Subscription
Datasets 1
GET
/v2/datasets/filtered_by_apps
List appdatasets for specific app ids with dependencies
AppRuns 7
GET
/v2/apps/{app_id}/app_runs
List of app runs
POST
/v2/apps/{app_id}/app_runs
Create AppRun
DELETE
/v2/apps/{app_id}/app_runs/{id}
Stop AppRun execution
PATCH
/v2/apps/{app_id}/app_runs/{id}
Update AppRun status. Used only for api key authentication.
GET
/v2/apps/{app_id}/app_runs/{id}
Return App Run
PATCH
/v2/apps/{app_id}/app_runs/{id}/stop
Stop AppRun execution
GET
/v2/apps/{app_id}/app_runs/duplicate_check
Check duplicate app run
AppStream 15
GET
/v1/app_streams
List AppStreams
POST
/v1/app_streams
Create AppStream
GET
/v2/app_streams
List AppStreams
GET
/v2/app_streams/idle_worker_stats
Get AppStream Auto Idle Job Stats
GET
/v2/app_streams/{id}
Show AppStream
GET
/v1/app_streams/{id}
Show AppStream
PATCH
/v1/app_streams/{id}
Update AppStream
DELETE
/v1/app_streams/{id}
Delete AppStream
POST
/v1/app_streams/{id}/clone
Clone AppStream
POST
/v1/app_streams/{id}/create_backfill_stream
Create Backfill App Stream for App Stream
POST
/v1/app_streams/{id}/force_resume
Force resuming consumers for stream
POST
/v1/app_streams/{id}/reset_data_schedules
Reset datatime scheduled app cursors and schedules for a purge/rerun window
PATCH
/v1/app_streams/batch_update
Batch Update AppStreams. Limited to 10 app streams
DELETE
/v1/app_streams/batch_destroy
Batch Deletion of AppStreams. Limited to 10 app streams
PATCH
/v1/app_streams/{id}/update_edr_provider_connection_status
Update edr provider connection time
AppConnection 5
POST
/v1/app_connections
Create AppConnection
GET
/v1/app_connections/{id}
Show AppConnection
PATCH
/v1/app_connections/{id}
Update AppConnection
DELETE
/v1/app_connections/{id}
Delete AppConnection
PATCH
/v1/app_connections/{id}/update_package
Update package version for AppConnection
Usage 2
GET
/v2/usage
Returns Usage records
GET
/v2/usage/summaries
Returns UsageSummary records
Workflows 20
GET
/v2/workflows
List Workflows
POST
/v2/workflows
Create a Workflow
GET
/v2/workflows/{id}
Show workflow
PATCH
/v2/workflows/{id}
Update a Workflow
DELETE
/v2/workflows/{id}
Delete a Workflow
GET
/v2/{workflow_id}/workflow_content_blocks
List Workflow Content Blocks of a workflow
POST
/v2/{workflow_id}/workflow_content_blocks
Create a Workflow Content Block
GET
/v2/{workflow_id}/workflow_content_blocks/{id}
Show Workflow Content Block
PATCH
/v2/{workflow_id}/workflow_content_blocks/{id}
Update a Workflow Content Block
DELETE
/v2/{workflow_id}/workflow_content_blocks/{id}
Delete a Workflow Content Block
GET
/v2/{workflow_id}/workflow_apps
List Workflow Apps of a Workflow
PUT
/v2/{workflow_id}/workflow_apps
Update many Workflow Apps
GET
/v2/{workflow_id}/workflow_apps/{id}
Show Workflow App
PATCH
/v2/{workflow_id}/workflow_apps/{id}
Update a Workflow App
GET
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows
List Dashboard Workflows of a Dashboard
GET
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}
Show Dashboard Workflow
DELETE
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}
Delete Dashboard Workflow
POST
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}/ungroup
Ungroup Dashboard Workflow
POST
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/ungroup_all
Ungroup All Dashboard Workflows for Dashboard
PUT
/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}/change_asset
Change Asset of Dashboard Workflows and related Dashboard Apps
WorkflowRoles 1
GET
/v2/workflow_roles
List WorkflowRoles
ColumnMapperTemplates 7
GET
/v2/column_mapper_templates
Get list of column mapper templates
POST
/v2/column_mapper_templates
Create column mapper template
GET
/v2/column_mapper_templates/{id}
Get one column mapper template by ID
PATCH
/v2/column_mapper_templates/{id}
Update column mapper
DELETE
/v2/column_mapper_templates/{id}
Delete column mapper
PATCH
/v2/column_mapper_templates/{id}/change_rig
Associate a rig with a column mapper template
PATCH
/v2/column_mapper_templates/{id}/change_intervention_unit
Associate an intervention unit with a column mapper template
ColumnMapperTemplateChannels 3
POST
/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels
Create column mapper template channel
PATCH
/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels/{id}
Update column mapper template channel
DELETE
/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels/{id}
Delete column mapper
ColumnMapperTemplateRules 3
POST
/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules
Create column mapper template rule
PATCH
/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules/{id}
Update column mapper template rule
DELETE
/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules/{id}
Delete column mapper template rule
CompetitorAnalysis 1
GET
/v1/competitor_analysis/statistics
Get Competitor Analysis statistics
Company 5
GET
/v2/app_companies
List companies which have access to Apps
GET
/v1/companies
List of Companies
GET
/v1/company/{id}
Show Company by ID
GET
/v1/company
Show current user Company
PATCH
/v1/company
Update Company
AppStoreTemplates 5
GET
/v2/app_store_templates
List AppStoreTemplates
POST
/v2/app_store_templates
Create a AppStoreTemplate
GET
/v2/app_store_templates/{id}
Show AppStoreTemplate
PATCH
/v2/app_store_templates/{id}
Update a AppStoreTemplate
DELETE
/v2/app_store_templates/{id}
Delete a AppStoreTemplate
AppStoreTemplateSections 5
GET
/v2/app_store_template_sections
List AppStoreTemplateSections
POST
/v2/app_store_template_sections
Create a AppStoreTemplateSection
GET
/v2/app_store_template_section/{id}
Show AppStoreTemplateSection
PATCH
/v2/app_store_template_section/{id}
Update a AppStoreTemplateSection
DELETE
/v2/app_store_template_section/{id}
Delete a AppStoreTemplateSection
AppStoreArticles 6
GET
/v2/app_store_articles
List AppStoreArticles
POST
/v2/app_store_articles
Create a AppStoreArticle
GET
/v2/app_store_articles/{id}
Show AppStoreArticle
PATCH
/v2/app_store_articles/{id}
Update a AppStoreArticle
DELETE
/v2/app_store_articles/{id}
Delete a AppStoreArticle
PATCH
/v2/app_store_articles/{id}/remove_section
Remove Section from AppStoreArticle
SignedUrl 1
GET
/v2/signed_url
Get signedurl from S3
Audits 8
GET
/v2/dataset_audits
List Dataset Audits
GET
/v2/permission_audits
List Permission Audits
GET
/v2/group_membership_audits
List Group Membership Audits
GET
/v2/provisioning_subscription_audits
List ProvisioningSubscription Audits
GET
/v2/platform_subscription_audits
List PlatformSubscription Audits
GET
/v2/purchase_subscription_audits
List PurchaseSubscription Audits
GET
/v2/package_audits
List Package Audits
GET
/v2/api_key_audits
List ApiKey Audits
Event 1
POST
/v2/events/publish
Publish Events
AppUsage 6
GET
/v2/usage_analytics/app_usage
Get Total App Usage Statistics
GET
/v2/usage_analytics/app_usage/usage_list
Get App Usage Statistics by user
GET
/v2/usage_analytics/app_usage/view_date_list
Get App Usage Statistics day by day
GET
/v2/usage_analytics/app_usage/top_apps
Get Top App Usage Statistics
GET
/v2/usage_analytics/app_usage/top_users
Get Top Users Usage Statistics
GET
/v2/usage_analytics/app_usage/total_usage_trend
Get Total AppUsage for each viewdate
PartialWellReruns 13
GET
/v2/partial_reruns
List Partial Well Reruns
POST
/v2/partial_reruns/list
List Partial Well Reruns
GET
/v2/partial_reruns/{id}
Show Partial Well Rerun
PATCH
/v2/partial_reruns/{id}
Update Partial Well Rerun
PATCH
/v2/partial_reruns/{id}/start_merging
Start rerun merging
PATCH
/v2/partial_reruns/{id}/resume
Change rerun status to synchronizingstreams
PATCH
/v2/partial_reruns/{id}/stop
Change rerun status to stop
PATCH
/v2/partial_reruns/{id}/fail
Change rerun status to failed
PATCH
/v2/partial_reruns/{id}/cancel
Change rerun status to canceled
PATCH
/v2/partial_reruns/{id}/restart
Restart partial rerun, which will change its status to running
GET
/v2/partial_reruns/{id}/app_progress/{app_id}
Show Partial Well Rerun App Progress
PATCH
/v2/partial_reruns/{id}/app_progress/{app_id}
Update Partial Well Rerun App Progress
POST
/v2/wells/{well_id}/partial_reruns
Create Partial Well Rerun
PartialWellRerunAppProgresses 3
GET
/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}
Show Partial Rerun App Progress
PATCH
/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}
Update Partial Rerun App Progress
PATCH
/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}/restart
Restart Partial Rerun App Progress
SearchSuggestions 1
GET
/v2/search_suggestions
Search suggestions for App, Workflow and Article
Goals 4
GET
/v2/goals
List Company Goals if no filters applied
POST
/v2/goals
Create a Goal
PATCH
/v2/goals/{id}
Update a Goal
DELETE
/v2/goals/{id}
Delete a Goal
Projects 6
GET
/v2/projects
List Projects
POST
/v2/projects
Create a Project
GET
/v2/projects/{id}
Show Project
PATCH
/v2/projects/{id}
Update a Project
DELETE
/v2/projects/{id}
Delete a Project
POST
/v2/projects/{id}
Clone a Project
ProjectFolders 5
GET
/v2/projects/{project_id}/project_folders
List ProjectFolders
POST
/v2/projects/{project_id}/project_folders
Create a ProjectFolder
GET
/v2/projects/{project_id}/project_folders/{id}
Show ProjectFolder
PATCH
/v2/projects/{project_id}/project_folders/{id}
Update a ProjectFolder
DELETE
/v2/projects/{project_id}/project_folders/{id}
Delete a ProjectFolder
ProjectFiles 5
GET
/v2/project_folders/{project_folder_id}/project_files
List ProjectFile
POST
/v2/project_folders/{project_folder_id}/project_files
Create a ProjectFile
GET
/v2/project_folders/{project_folder_id}/project_files/{id}
Show ProjectFile
PATCH
/v2/project_folders/{project_folder_id}/project_files/{id}
Update a ProjectFile
DELETE
/v2/project_folders/{project_folder_id}/project_files/{id}
Delete a ProjectFile
RegisteredModels 1
GET
/v2/integration/registered_models
Show list of Registered Models
AppSchedule 5
POST
/v1/app_schedules
Create App schedule
POST
/v1/app_schedules/bulk_update_status
Bulk update status for list of App Schedule
GET
/v1/app_schedules/{id}
Retrieve App schedules
PATCH
/v1/app_schedules/{id}
Update app schedule
DELETE
/v1/app_schedules/{id}
Delete app schedule
EdrProviders 6
GET
/v2/edr_providers
Get a list of edr providers
POST
/v2/edr_providers
Create a edr provider
GET
/v2/edr_providers/{id}
Get an Edr provider
PATCH
/v2/edr_providers/{id}
Update an Edr provider
DELETE
/v2/edr_providers/{id}
Delete an Edr provider
POST
/v2/edr_providers/{id}/test_connection
Get an Edr provider
TypeWells 3
GET
/v2/wells/{well_id}/type_wells
Get typewells from a primary well
POST
/v2/wells/{well_id}/type_wells
Add new typewell well to a primary well
DELETE
/v2/wells/{well_id}/type_wells/{id}
Remove typewell well from a primary well
Tool Ordering 34
Customer tool order create/edit/submit and the specification definition registry
GET
/v2/tool_ordering/orders
List Tool Orders
POST
/v2/tool_ordering/orders
Create Tool Order
GET
/v2/tool_ordering/orders/{id}
Get Tool Order
PATCH
/v2/tool_ordering/orders/{id}
Update Draft Tool Order
DELETE
/v2/tool_ordering/orders/{id}
Delete Draft Tool Order
POST
/v2/tool_ordering/orders/{id}/submit
Submit Tool Order
POST
/v2/tool_ordering/orders/{id}/acknowledge
Acknowledge Tool Order (vendor action)
POST
/v2/tool_ordering/orders/{id}/cancel
Cancel Tool Order
POST
/v2/tool_ordering/orders/{order_id}/components/{id}/transition
Transition Order Component Status (vendor action)
PATCH
/v2/tool_ordering/orders/{order_id}/components/{id}/final_specs
Update Order Component Final Specs (vendor action)
POST
/v2/tool_ordering/orders/{order_id}/components/receive
Receive Shipped Order Components On Rig (internal action)
GET
/v2/tool_ordering/orders/{order_id}/proposals
List Component Change Proposals
POST
/v2/tool_ordering/orders/{order_id}/proposals
Submit Component Change Proposal (vendor action)
POST
/v2/tool_ordering/orders/{order_id}/proposals/{id}/approve
Approve Component Change Proposal
POST
/v2/tool_ordering/orders/{order_id}/proposals/{id}/reject
Reject Component Change Proposal
POST
/v2/tool_ordering/orders/{order_id}/proposals/approve_all
Approve Selected Component Change Proposals Atomically
POST
/v2/tool_ordering/orders/{order_id}/proposals/reject_all
Reject Selected Component Change Proposals Atomically
GET
/v2/tool_ordering/orders/{order_id}/attachments
List Order Attachments
POST
/v2/tool_ordering/orders/{order_id}/attachments
Register Uploaded Order Attachment
POST
/v2/tool_ordering/orders/{order_id}/attachments/signed_url
Presign Order Attachment Upload
DELETE
/v2/tool_ordering/orders/{order_id}/attachments/{id}
Delete Order Attachment
GET
/v2/tool_ordering/specifications
Get Tool Specification Definition
GET
/v2/tool_ordering/vendors
List Vendors
POST
/v2/tool_ordering/vendors
Create Vendor
PATCH
/v2/tool_ordering/vendors/{id}
Update Vendor
GET
/v2/tool_ordering/vendors/{vendor_id}/memberships
List Vendor Memberships
POST
/v2/tool_ordering/vendors/{vendor_id}/memberships
Add Vendor Membership
PATCH
/v2/tool_ordering/vendors/{vendor_id}/memberships/{id}
Update Vendor Membership
POST
/v2/tool_ordering/vendor_contacts
Add Vendor Contact
DELETE
/v2/tool_ordering/vendor_contacts/{id}
Remove Vendor Contact
GET
/v2/tool_ordering/vendor_directory
List Vendor Directory
GET
/v2/tool_ordering/distribution_contacts
List Company Distribution Contacts
POST
/v2/tool_ordering/distribution_contacts
Add Company Distribution Contact
DELETE
/v2/tool_ordering/distribution_contacts/{id}
Remove Company Distribution Contact
WellDrilloutUnitRuns 2
GET
/v2/well_drillout_unit_runs
List well drillout unit runs
GET
/v2/well_drillout_unit_runs/{id}
Get a single well drillout unit run
PadFracFleets 4
GET
/v2/pad_frac_fleets
List Pad/Frac Fleet Relations
POST
/v2/pad_frac_fleets
Create Pad/Frac Fleet Relation
PATCH
/v2/pad_frac_fleets/{id}
Patch Pad/Frac Fleet Relation
DELETE
/v2/pad_frac_fleets/{id}
Delete Pad/Frac Fleet Relation
FracFleetContracts 5
GET
/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts
List Company Goals if no filters applied
POST
/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts
Create Frac Fleet Contract
GET
/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}
List Company Goals if no filters applied
PATCH
/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}
Update Frac Fleet Contract
DELETE
/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}
Delete Frac Fleet Contract
InterventionUnits 4
GET
/v2/intervention_units
Get a list of Intervention Units
POST
/v2/intervention_units
Create an Intervention Unit
PATCH
/v2/intervention_units/{id}
Update Intervention Unit
DELETE
/v2/intervention_units/{id}
Delete Intervention Unit
InterventionUnitEvents 4
GET
/v2/intervention_unit_events
Get a list of Intervention Units Events by well
POST
/v2/wells/{well_id}/intervention_unit_events
Create an Intervention Unit Event
PATCH
/v2/intervention_unit_events/{id}
Update Intervention Unit Event
DELETE
/v2/intervention_unit_events/{id}
Delete Intervention Unit Event
Data Export App 7
GET
/v2/data_export_app
Get enriched well export data
POST
/v2/data_export_app/list
Get enriched well export data
GET
/v2/data_export_app/column_fields
Get column fields for a column in export index endpoint
POST
/v2/data_export_app/column_fields_list
Get column fields for a column in export index endpoint
POST
/v2/data_export_app/flat
Get flat JSON:API-like response for global sorting
GET
/v2/data_export_app/activity_code_mappings
Get activity code type mappings for a company
GET
/v2/data_export_app/metrics_definitions
Get dynamic metric definitions for a company
Countries 1
GET
/v2/country_list
Get list of available countries
RevoltChat 1
POST
/v2/integration/revolt_chat_sessions
Create or fetch Revolt Chat session
InterventionUnitReruns 3
GET
/v2/intervention_unit_reruns
Get a list of Intervention Unit Reruns
POST
/v2/intervention_unit_reruns
Create an Intervention Unit Rerun
GET
/v2/intervention_unit_reruns/{id}
Get Intervention Unit Rerun by ID
Schemas 574
The contract defines 574 schemas that model the data the API accepts and returns. The most detailed are WellCache (38 properties), Alert (30 properties), AppStreamItem (28 properties), DataExportWell (27 properties). Each schema is shown below with its type and property counts.
AuthenticationError
object
2 properties
2 required
AuthorizationError
object
2 properties
2 required
NotFoundError
object
2 properties
2 required
FeatureStatus
object
3 properties
PermissionStatus
object
1 property
ActivityPost
object
11 properties
1 required
ActivityWell
object
3 properties
ActivityRig
object
3 properties
V2Activity
object
4 properties
2 required
ActivitiesList
object
2 properties
ActivitySingle
object
2 properties
ActivityPayload
object
1 property
Comment
object
9 properties
1 required
CommentPayload
object
1 property
CommentV2
object
4 properties
Like
object
3 properties
1 required
AlertDefinition
object
25 properties
1 required
ContextResponse
object
1 property
TriggerResponse
object
2 properties
CheckResponse
object
2 properties
AlertDefinitionV2
object
3 properties
AlertDefinitionFilterLevelV2
object
6 properties
AlertDefinitionConstraintV2
object
6 properties
AlertDefinitionFilterV2
object
16 properties
AlertDefinitionV2List
object
1 property
AlertDefinitionV2Single
object
1 property
AlertGroupAlertDefinitionPayload
object
1 property
AlertGroupAlertDefinitionBulkPayload
object
1 property
AlertGroupAlertDefinitionUnassignResult
object
2 properties
AlertDefinitionV2Payload
object
1 property
AlertGroup
object
3 properties
AlertGroupList
object
1 property
AlertGroupSingle
object
1 property
AlertGroupPayload
object
1 property
AlertGroupUser
object
4 properties
AlertGroupUserList
object
1 property
AlertGroupUserSingle
object
1 property
AlertGroupUserPayload
object
1 property
AlertGroupScope
object
3 properties
AlertGroupScopeList
object
1 property
AlertGroupScopeSingle
object
1 property
AlertGroupScopePayload
object
1 property
AlertGroupConfiguration
object
3 properties
AlertGroupConfigurationList
object
1 property
AlertGroupConfigurationSingle
object
1 property
AlertGroupConfigurationPayload
object
1 property
AlertGroupUserInput
object
2 properties
AlertGroupUserBulkPayload
object
1 property
AlertGroupScopeInput
object
2 properties
AlertGroupScopeBulkPayload
object
1 property
AlertGroupConfigurationInput
object
5 properties
AlertGroupConfigurationBulkCreatePayload
object
1 property
AlertGroupConfigurationBulkDestroyPayload
object
1 property
BulkDeleteResult
object
2 properties
AlertGroupMergePayload
object
1 property
1 required
AlertNotificationTypeV2
object
3 properties
AlertNotificationTypeV2List
object
1 property
AlertAbilityCatalogItem
object
3 properties
3 required
AlertAbilityCatalog
object
1 property
AlertRole
object
3 properties
AlertRoleList
object
1 property
AlertRoleSingle
object
1 property
AlertRolePayload
object
1 property
AlertRoleAbilitiesPayload
object
1 property
AlertRbacStatus
object
1 property
AlertOccurrence
object
22 properties
1 required
AlertOccurrenceClassificationPayload
object
1 property
AlertTotals
object
4 properties
Alert
object
30 properties
1 required
AlertAcknowledgementPayload
object
1 property
AlertBulkAcknowledgementPayload
object
1 property
AlertClassificationPayload
object
1 property
AlertTransitionPayload
object
1 property
AlertEscalation
object
8 properties
2 required
AlertEscalatePayload
object
1 property
AlertActivity
object
9 properties
1 required
AlertV2
object
3 properties
AlertUserV2
object
5 properties
AlertEscalationUserV2
object
6 properties
AlertV2List
object
1 property
AlertV2Single
object
1 property
AlertClassificationPayloadV2
object
1 property
AlertCheckResultV2
object
4 properties
AlertTotalsV2
object
4 properties
AlertDetailsV2
object
3 properties
AlertDetailsV2List
object
1 property
AlertTag
object
3 properties
AlertTagList
object
1 property
AlertTagSingle
object
1 property
AlertTagPayload
object
1 property
AlertWorkflow
object
7 properties
3 required
AlertWorkflowList
array
AlertWorkflowV2
object
3 properties
AlertWorkflowV2List
object
1 property
AlertWorkflowV2Single
object
1 property
AuthenticationPlatformV2
object
3 properties
AuthenticationPlatformV2List
object
1 property
AuthenticationPlatformV2Single
object
1 property
AppReview
object
4 properties
AppReviewList
object
1 property
Favorites
object
4 properties
2 required
Asset
object
4 properties
2 required
AssetAutocomplete
object
1 property
AssetResolver
object
3 properties
TypeWell
object
3 properties
Rerun
object
4 properties
2 required
AncestorsResponse
ProgramPayload
object
1 property
Program
object
3 properties
1 required
ProgramCluster
object
5 properties
PadPayload
object
2 properties
Pad
object
3 properties
1 required
PadDetails
PadCluster
object
4 properties
RigPayload
object
4 properties
Rig
object
3 properties
1 required
RigCluster
object
6 properties
WellCacheRecord
DrilloutUnitPayload
object
4 properties
DrilloutUnit
object
3 properties
1 required
DrilloutUnitCluster
object
5 properties
WellPayload
object
17 properties
Well
object
3 properties
1 required
WellCluster
object
5 properties
FracFleetPayload
object
1 property
FracFleetUpdatePayload
object
2 properties
FracFleet
object
3 properties
1 required
FracFleetCluster
object
4 properties
WirelinePayload
object
1 property
Wireline
object
3 properties
1 required
AuthenticationSchemaV2
object
3 properties
AuthenticationSchemaV2List
object
1 property
AuthenticationSchemaV2Single
object
1 property
CompanyDomainV2
object
3 properties
CompanyDomainV2List
object
1 property
CompanyDomainV2Single
object
1 property
CompanyDomainV2Payload
object
1 property
DashboardAppAnnotation
object
4 properties
4 required
DashboardAppAnnotationList
object
2 properties
DashboardAppWithLastAnnotationList
array
DashboardAppWithLastAnnotation
object
2 properties
DashboardAppAnnotationSingle
object
2 properties
DashboardAppAnnotationPayload
object
1 property
DashboardAppAnnotationUpdatePayload
object
1 property
DashboardApp
object
4 properties
DashboardAppList
object
1 property
DashboardAppBatchUpdatePayload
object
1 property
BulkCreatedDashboardApps
DashboardFolder
object
4 properties
DashboardFolderPayload
object
1 property
DashboardFolderList
object
1 property
DashboardFolderDashboardShare
object
4 properties
DashboardFolderDashboardSharePayload
object
1 property
DashboardFolderDashboardShareUpdatePayload
object
1 property
DashboardFolderShare
object
4 properties
DashboardFolderShareList
object
2 properties
DashboardFolderShareCreatePayload
object
1 property
DashboardFolderShareUpdatePayload
object
1 property
Dashboard
object
18 properties
6 required
DashboardV2
object
4 properties
DashboardV2Minimum
object
3 properties
DashboardV2Payload
object
1 property
DashboardV2List
object
1 property
DashboardMinimumV2List
object
1 property
DashboardTimezones
object
5 properties
WellPlanChecklistV2
object
4 properties
WellPlanChecklistV2Response
object
1 property
WellPlanChecklistV2List
object
1 property
WellPlanV2
object
4 properties
WellPlanV2Payload
object
1 property
1 required
WellPlanV2UpdatePayload
object
1 property
1 required
WellPlanV2Response
object
1 property
WellPlanV2List
object
1 property
WellPlanCopyV2
object
3 properties
WellPlanCopyV2Payload
object
4 properties
2 required
WellPlanCopyV2Response
object
1 property
WellPlanningDashboardV2
object
4 properties
WellPlanningDashboardV2Payload
object
2 properties
2 required
WellPlanningDashboardV2UpdatePayload
object
1 property
1 required
WellPlanningDashboardV2Response
object
1 property
WellPlanningDashboardV2List
object
1 property
WellPlanningDashboardAppV2Payload
object
5 properties
WellPlanningDashboardAppV2BulkCreatePayload
object
6 properties
Data
object
4 properties
2 required
DataFilter
object
3 properties
DataFilterList
object
1 property
DataFilterPayload
object
5 properties
DataFilterPayload2
object
6 properties
File
object
3 properties
SignedFile
object
4 properties
Group
object
4 properties
GroupUser
object
4 properties
GroupCreatePayload
object
1 property
GroupUpdatePayload
object
1 property
GroupList
object
1 property
GroupConnection
object
4 properties
GroupConnectionList
object
1 property
GroupsUsersPayload
object
1 property
WellViewIngest
object
4 properties
3 required
WellViewBHA
object
4 properties
WellViewFrac
object
4 properties
WellViewFracStageDesign
object
4 properties
WellViewFracStageSummary
object
4 properties
WellViewFracStageSummaryCalculated
object
4 properties
WellViewJobSettings
object
4 properties
WellViewPlugs
object
4 properties
JwksKey
object
JWKS public key for JWT token verification
6 properties
JwksResponse
object
JWKS (JSON Web Key Set) containing public keys for verifying JWT tokens
1 property
MessageProducerPayload
object
4 properties
Notification
object
10 properties
1 required
NotificationPayload
object
1 property
UnreadCount
object
1 property
NotificationPolicy
object
3 properties
NotificationPolicyScopeInput
object
4 properties
NotificationPolicyFilterInput
object
4 properties
NotificationPolicyThresholdInput
object
4 properties
NotificationPolicyList
object
1 property
NotificationPolicySingle
object
1 property
NotificationPolicyPayload
object
1 property
1 required
SecurityPolicy
object
3 properties
SecurityPolicyList
object
1 property
CompanySecurityPolicy
object
4 properties
CompanySecurityPolicyList
object
1 property
CompanySecurityPolicyCreatePayload
object
1 property
CompanySecurityPolicyUpdatePayload
object
1 property
AuthenticationSchemaContextV2
object
3 properties
AuthenticationSchemaContextV2List
object
2 properties
Permission
object
4 properties
PermissionGroup
object
4 properties
PermissionGroupList
object
1 property
PermissionOnGroup
object
4 properties
PermissionInList
object
4 properties
PermissionPayload
object
1 property
BulkPermissionPayload
object
1 property
PermissionList
object
1 property
Picklist
object
4 properties
2 required
PicklistPayload
object
4 properties
PicklistUpdatePayload
object
3 properties
PicklistItem
object
6 properties
2 required
PicklistItemPayload
object
4 properties
Task
object
3 properties
2 required
TaskConfiguration
object
6 properties
TaskPayload
object
2 properties
TaskShow
object
9 properties
TaskSchedule
object
3 properties
TaskScheduleList
object
1 property
TaskScheduleSingle
object
1 property
TaskScheduleCreatePayload
object
1 property
1 required
TaskScheduleUpdatePayload
object
Partial update. appid, companyid, createdbyid, ownertype, and ownerid are immutable; supplying one returns 400.
1 property
1 required
TaskScheduleDeleted
object
1 property
1 required
TaskScheduleBadRequest
object
2 properties
2 required
AuthenticationResponse
object
Authentication response containing JWT tokens. By default returns HMAC (HS256) tokens. To receive JWKS (RS256) tokens, include "X-Token-Format: jwks" header or…
5 properties
EmailPasswordAuthentication
object
2 properties
EmailPasswordMFAAuthentication
object
4 properties
RefreshTokenAuthentication
object
2 properties
Auth0Authentication
object
2 properties
AuthenticationSchema
object
3 properties
V1UserMinimal
object
9 properties
UserMinimal
object
5 properties
User
object
4 properties
UserPayloadCreate
object
1 property
UserPayloadUpdate
object
1 property
UserList
object
1 property
UserStreaksList
object
1 property
UserSettings
object
5 properties
UserSettingsPayload
object
3 properties
UserSettingsUpdated
object
7 properties
IdentityVerifier
object
3 properties
IdentityVerifierList
object
1 property
ApiKey
object
4 properties
ApiKeyPayload
object
1 property
ApiKeyList
object
1 property
AppCategory
object
3 properties
AppCategoryList
object
1 property
AppCategoryLookUp
object
2 properties
AppCategoryLookUpList
object
1 property
AppType
object
6 properties
AppTypeList
object
1 property
App
object
4 properties
CreateAppPayload
object
1 property
UpdateAppPayload
object
1 property
AppList
object
1 property
Package
object
4 properties
UpdatePackagePayload
object
1 property
PackageList
object
1 property
Installation
object
3 properties
AppSecretParameterPayload
object
2 properties
AppDataset
object
4 properties
AppDatasetList
object
1 property
AppDatasetPayload
object
1 property
AppHelpContent
object
4 properties
AppHelpContentPayload
object
1 property
AppHelpContentList
object
1 property
AppLogStream
object
3 properties
AppLogStreamList
object
1 property
AppLogStreamEvent
object
3 properties
AppLogStreamEventList
object
1 property
AppLogFilterEvent
object
5 properties
AppLogFilterEventList
object
1 property
AppTypePayload
object
3 properties
AppSettingsTemplate
object
3 properties
AppSettingsTemplateShare
object
4 properties
AppSettingsTemplatePayload
object
1 property
AppSettingsTemplateList
object
1 property
AppSettingsTemplateShareList
object
1 property
PublishAppSettingsTemplatePayload
object
1 property
AppStreamTemplate
object
4 properties
AppStreamTemplateApp
object
4 properties
AppStreamTemplateAppSummary
object
3 properties
AppStreamTemplatePayload
object
1 property
AppStreamTemplateAppPayload
object
1 property
AppStreamTemplateShow
object
2 properties
AppStreamTemplateList
object
1 property
DatasetType
object
3 properties
DatasetTypePayload
object
3 properties
DatasetTypeList
object
1 property
DocumentIndex
object
3 properties
Document
object
3 properties
DocumentPayload
object
1 property
DocumentList
object
1 property
DocumentSection
object
3 properties
DocumentSectionPayload
object
1 property
DocumentSectionList
object
1 property
RigTemplateIndex
object
3 properties
RigTemplate
object
4 properties
RigTemplatePayload
object
1 property
RigTemplateList
object
1 property
RigTemplateCategoryIndex
object
3 properties
RigTemplateCategory
object
3 properties
RigTemplateCategoryPayload
object
1 property
RigTemplateCategoryList
object
1 property
RigTemplateItemIndex
object
3 properties
RigTemplateItem
object
3 properties
RigTemplateItemPayload
object
1 property
RigTemplateItemList
object
1 property
InterventionUnitTemplate
object
3 properties
InterventionUnitTemplatePayload
object
1 property
InterventionUnitTemplateList
object
1 property
InterventionUnitTemplateCategory
object
3 properties
InterventionUnitTemplateCategoryPayload
object
1 property
InterventionUnitTemplateCategoryList
object
1 property
InterventionUnitTemplateItem
object
3 properties
InterventionUnitTemplateItemPayload
object
1 property
InterventionUnitTemplateItemList
object
1 property
Tier
object
4 properties
TierPayload
object
1 property
TierList
object
1 property
ProductSubscription
object
4 properties
ProductSubscriptionPayload
object
1 property
ProductSubscriptionUpdatePayload
object
1 property
ProductSubscriptionList
object
1 property
PlatformSubscription
object
4 properties
PlatformSubscriptionPayload
object
1 property
PlatformSubscriptionUpdatePayload
object
1 property
PlatformSubscriptionList
object
1 property
ProvisioningSubscription
object
4 properties
ProvisioningSubscriptionPayload
object
1 property
ProvisioningSubscriptionUpdatePayload
object
1 property
ProvisioningSubscriptionList
object
1 property
PurchaseSubscription
object
4 properties
PurchaseSubscriptionUpdatePayload
object
1 property
PurchaseSubscriptionList
object
1 property
SubscriptionFeature
object
3 properties
SubscriptionFeatureList
object
1 property
WellCache
object
38 properties
WellCacheList
object
1 property
BlacklistedDataset
object
4 properties
CreateBlacklistedDataset
object
1 property
BulkCreateBlacklistedDataset
object
1 property
AppMetric
object
2 properties
AppMetricList
object
3 properties
AppMetricsList
AppMetricError
object
1 property
AppAssetStream
object
5 properties
AppAssetList
object
3 properties
PackageReview
object
3 properties
PackageReviewCreatePayload
object
1 property
PackageReviewUpdatePayload
object
1 property
PackageReviewList
object
1 property
AppPurchase
object
4 properties
AppPurchaseList
object
1 property
PurchaseSubscriptionPayload
object
12 properties
AppPurchasePayload
object
1 property
Dataset
object
3 properties
AppRunDeveloper
object
6 properties
AppRun
object
4 properties
AppRunSingle
object
2 properties
AppRunList
object
2 properties
AppRunCreatePayload
object
4 properties
AppConnectionItem
object
13 properties
AppStreamItem
object
28 properties
V2AppStreamIndex
object
4 properties
V2AppStreamItem
object
2 properties
AppConnectionSettingsBackfillPayload
object
2 properties
AppStreamList
V2AppStreamList
object
2 properties
AppStreamBatchUpdatePayload
object
1 property
AppConnectionUpdateItemPayload
object
3 properties
AppConnectionResponse
object
13 properties
AppConnectionPayload
object
5 properties
AppErrorAlert
object
3 properties
AppErrorAlertPayload
object
1 property
Usage
object
10 properties
UsageSummary
object
11 properties
UsageTotal
object
6 properties
UsageSummaryTotal
object
6 properties
WorkflowIndex
object
4 properties
Workflow
object
2 properties
WorkflowList
object
2 properties
WorkflowPayload
object
1 property
WorkflowContentBlock
object
4 properties
WorkflowContentBlockList
object
2 properties
WorkflowContentBlockPayload
object
1 property
WorkflowApp
object
4 properties
WorkflowAppList
object
2 properties
WorkflowAppsPayload
object
1 property
WorkflowAppPayload
object
1 property
WorkflowRoleIndex
object
4 properties
WorkflowRoleList
object
2 properties
ColumnMapperTemplate
object
3 properties
ColumnMapperTemplates
object
1 property
CreateColumnMapperTemplatePayload
object
2 properties
UpdateColumnMapperTemplatePayload
object
2 properties
ColumnMapperTemplateChannel
object
4 properties
CreateColumnMapperTemplateChannelPayload
object
1 property
UpdateColumnMapperTemplateChannelPayload
object
1 property
ColumnMapperTemplateRule
object
3 properties
ColumnMapperChannelRules
object
1 property
ColumnMapperTemplateRulePayload
object
1 property
DashboardWorkflow
object
4 properties
DashboardWorkflowList
object
2 properties
DashboardWorkflowSingle
object
2 properties
CompetitorStatsData
object
2 properties
CompanyType
object
3 properties
CompanyListStructure
object
1 property
AppStoreTemplateObject
object
4 properties
AppStoreTemplateList
object
2 properties
AppStoreTemplatePayload
object
1 property
AppStoreTemplateSectionObject
object
4 properties
AppStoreTemplateSectionList
object
2 properties
AppStoreTemplateSectionPayload
object
1 property
AppStoreArticleObject
object
5 properties
AppStoreArticleList
object
1 property
AppStoreArticlePayload
object
1 property
DatasetAuditIndex
object
4 properties
DatasetAudit
object
1 property
DatasetAuditList
object
1 property
PermissionAuditIndex
object
4 properties
PermissionAudit
object
2 properties
PermissionAuditList
object
2 properties
GroupMembershipAuditIndex
object
4 properties
GroupMembershipAudit
object
2 properties
GroupMembershipAuditList
object
2 properties
ProvisioningSubscriptionAuditIndex
object
4 properties
ProvisioningSubscriptionAudit
object
2 properties
ProvisioningSubscriptionAuditList
object
2 properties
PlatformSubscriptionAuditIndex
object
4 properties
PlatformSubscriptionAudit
object
2 properties
PlatformSubscriptionAuditList
object
2 properties
PurchaseSubscriptionAuditIndex
object
4 properties
PurchaseSubscriptionAudit
object
2 properties
PurchaseSubscriptionAuditList
object
2 properties
EventPayload
object
5 properties
EventFailureResponse
object
2 properties
TotalAppUsage
object
3 properties
AppUsageByUser
object
3 properties
AppUsageByViewDate
object
3 properties
TotalAppUsageList
object
1 property
AppUsageByUserList
object
1 property
AppUsageByViewDateList
object
1 property
AppUsageTopApps
object
3 properties
AppUsageTopAppsList
object
1 property
TotalAppUsageTrend
object
1 property
PartialWellRerun
object
4 properties
PartialWellRerunFull
object
2 properties
PartialWellRerunAppProgress
object
5 properties
PartialWellRerunDatasetProgress
object
3 properties
CreatePartialWellRerunPayload
object
1 property
UpdatePartialWellRerunPayload
object
1 property
UpdatePartialWellRerunAppProgressPayload
object
1 property
SearchSuggestionItem
object
3 properties
SearchSuggestionResult
object
1 property
CompanyV1
object
13 properties
CompanyV1List
CompanyV1Payload
object
5 properties
CompanyV1UnitSystemParam
object
1 property
Goal
object
3 properties
GoalCreatePayload
object
1 property
GoalUpdatePayload
object
1 property
ProjectObject
object
2 properties
ProjectList
object
2 properties
ProjectPayload
object
1 property
ProjectFolderObject
object
2 properties
ProjectFolderList
object
2 properties
ProjectFolderPayload
object
1 property
ProjectFileObject
object
2 properties
ProjectFileList
object
2 properties
ProjectFilePayload
object
1 property
AppSchedule
object
11 properties
CreateAppSchedulePayload
object
1 property
UpdateAppSchedulePayload
object
1 property
PackageAuditIndex
object
4 properties
PackageAudit
object
2 properties
PackageAuditList
object
2 properties
EdrProvider
object
3 properties
EdrProviders
object
1 property
ApiKeyAuditIndex
object
4 properties
ApiKeyAuditList
object
2 properties
ToolOrderComponent
object
13 properties
ToolOrder
object
3 properties
ToolOrderList
object
1 property
ToolOrderSingle
object
1 property
ToolOrderPayload
object
1 property
ToolOrderingSpecificationField
object
5 properties
ToolOrderingSpecification
object
3 properties
VendorContact
object
4 properties
Vendor
object
3 properties
VendorList
object
1 property
VendorSingle
object
1 property
VendorPayload
object
1 property
VendorContactPayload
object
1 property
VendorContactCreated
object
1 property
VendorDirectoryEntry
object
6 properties
VendorDirectoryList
object
1 property
DeletedStatus
object
1 property
ChangeProposalComponent
object
9 properties
ChangeProposal
object
12 properties
ChangeProposalSingle
object
1 property
ChangeProposalList
object
1 property
ChangeProposalDecisionSingle
object
2 properties
ChangeProposalDecisionList
object
2 properties
OrderAttachment
object
8 properties
OrderAttachmentSingle
object
1 property
OrderAttachmentList
object
1 property
OrderAttachmentPresign
object
1 property
OrderAttachmentDeleted
object
1 property
VendorMembership
object
7 properties
VendorMembershipList
object
1 property
VendorMembershipSingle
object
1 property
VendorMembershipCreatePayload
object
1 property
VendorMembershipUpdatePayload
object
1 property
DistributionContact
object
4 properties
DistributionContactList
object
1 property
DistributionContactSingle
object
1 property
WellDrilloutUnitRun
object
4 properties
WellDrilloutUnitRunList
object
2 properties
WellDrilloutUnitRunResponse
object
2 properties
PadFracFleet
object
4 properties
CreatePadFracFleetPayload
object
1 property
UpdatePadFracFleetPayload
object
1 property
FracFleetContract
object
3 properties
FracFleetContractCreatePayload
object
1 property
FracFleetContractUpdatePayload
object
1 property
InterventionUnit
object
3 properties
InterventionUnitPayload
object
4 properties
InterventionUnitEvent
object
3 properties
CreateInterventionUnitEventPayload
object
6 properties
UpdateInterventionUnitEventPayload
object
5 properties
DataExportWell
object
27 properties
DataExportWellList
object
3 properties
ActivityCodeMapping
object
2 properties
ActivityCodeMappingsList
object
1 property
MetricDefinition
object
5 properties
MetricsDefinitionsGroup
object
3 properties
MetricsDefinitionsSegment
object
3 properties
MetricsDefinitionsList
object
1 property
DataExportFlatItem
object
4 properties
DataExportIncludedWell
object
3 properties
DataExportFlatMeta
object
5 properties
DataExportFlatResponse
object
3 properties
Country
object
2 properties
CountryList
object
1 property
InterventionUnitRerun
object
3 properties
CreateInterventionUnitRerunPayload
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Corva AI 2
Other APIs Corva AI publishes across the network.
Corva Data API
Corva Dev Center
#Platform API#Assets#Wells#Rigs#Swagger#Drilling
Where this information came from
This is an independent, third-party profile of Corva Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.