Documentation

REST API reference (v1)

Generated from the shared contract route table. Agent protocol: datanivra.agent/v1.

All v1 routes
MethodPathOperationAuthPermissionRequest → response
GET/v1/healthgetHealthPublic—— → HealthStatus
GET/v1/health/livegetLivenessPublic—— → HealthStatus
POST/v1/auth/dev-logindevLoginPublic—DevLogin → SessionToken
GET/v1/auth/oidc/configgetOidcConfigPublic—— → OidcConfig
POST/v1/auth/oidc/startstartOidcLoginPublic—OidcLoginStart → OidcAuthorization
POST/v1/auth/oidc/callbackcompleteOidcLoginPublic—OidcCallback → SessionToken
POST/v1/auth/oidc/exchangeexchangeOidcTokenPublic—OidcTokenExchange → SessionToken
GET/v1/auth/signup/configgetSignupConfigPublic—— → SignupConfig
POST/v1/auth/signup/startstartSignupPublic—SignupStart → SignupAccepted
POST/v1/auth/signup/verifyverifySignupPublic—SignupVerify → SignupTicket
POST/v1/auth/signup/slugsuggestTenantSlugPublic—SlugRequest → SlugSuggestion
POST/v1/auth/signup/completecompleteSignupPublic—SignupComplete → SessionToken
POST/v1/auth/email/startstartEmailLoginPublic—EmailLoginStart → SignupAccepted
POST/v1/auth/email/completecompleteEmailLoginPublic—EmailLoginComplete → SessionToken
POST/v1/auth/cli/startstartCliLoginPublic—CliLoginStart → CliLoginStarted
POST/v1/auth/cli/tokenpollCliLoginPublic—CliLoginPoll → SessionToken
POST/v1/auth/cli/describedescribeCliLoginUser—CliLoginLookup → CliLoginRequestInfo
POST/v1/auth/cli/decidedecideCliLoginUser—CliLoginDecision → CliLoginRequestInfo
POST/v1/auth/session/refreshrefreshSessionUser—— → SessionToken
POST/v1/auth/logoutlogoutUser—— → LogoutResult
GET/v1/megetMeUser—— → User
GET/v1/tenantgetTenantUser—— → Tenant
GET/v1/organizationgetOrganizationUser—— → Organization
PATCH/v1/organizationupdateOrganizationUserorg.adminOrganizationUpdate → Organization
GET/v1/organization/separation-of-dutiesgetSeparationOfDutiesUserorg.admin— → SeparationOfDutiesSettings
PATCH/v1/organization/separation-of-dutiesupdateSeparationOfDutiesUserorg.adminSeparationOfDutiesSettings → SeparationOfDutiesSettings
GET/v1/organization/execution-isolationgetExecutionIsolationUserorg.admin— → ExecutionIsolationRequirement
PATCH/v1/organization/execution-isolationupdateExecutionIsolationUserorg.adminExecutionIsolationRequirement → ExecutionIsolationRequirement
GET/v1/roleslistRolesUser—— → RoleDefinition[]
GET/v1/userslistUsersUseruser.manage— → User[]
POST/v1/usersinviteUserUseruser.manageUserInvite → User
PATCH/v1/users/{user_id}/rolesupdateUserRolesUseruser.manageRoleAssignmentUpdate → User
POST/v1/users/{user_id}/disabledisableUserUseruser.manage— → User
POST/v1/users/{user_id}/enableenableUserUseruser.manage— → User
POST/v1/auth/workload/tokenexchangeWorkloadTokenPublic—WorkloadTokenExchange → SessionToken
GET/v1/workload-identitieslistWorkloadIdentitiesUserorg.admin— → WorkloadIdentityTrust[]
POST/v1/workload-identitiescreateWorkloadIdentityUserorg.adminWorkloadIdentityTrustCreate → WorkloadIdentityTrust
GET/v1/workload-identities/{workload_identity_id}getWorkloadIdentityUserorg.admin— → WorkloadIdentityTrust
POST/v1/workload-identities/{workload_identity_id}/disabledisableWorkloadIdentityUserorg.adminWorkloadIdentityDisable → WorkloadIdentityTrust
GET/v1/organization/test-data-settingsgetTestDataSettingsUserorg.admin— → TestDataSettings
PATCH/v1/organization/test-data-settingsupdateTestDataSettingsUserorg.adminTestDataSettingsUpdate → TestDataSettings
GET/v1/agentslistAgentsUseragent.read— → AgentRegistration[]
GET/v1/agents/{agent_id}getAgentUseragent.read— → AgentRegistration
POST/v1/agents/enrollment-tokenscreateEnrollmentTokenUseragent.manageAgentEnrollmentTokenRequest → EnrollmentTokenIssued
POST/v1/agents/{agent_id}/revokerevokeAgentUseragent.manage— → AgentRegistration
POST/v1/agent/enrollagentEnrollEnrollment token—AgentEnvelope → ControlPlaneEnvelope
POST/v1/agent/tokenagentTokenAgent—— → AgentAccessToken
POST/v1/agent/heartbeatagentHeartbeatAgent—AgentEnvelope → ControlPlaneEnvelope
POST/v1/agent/leasesagentLeaseAgent—AgentEnvelope → ControlPlaneEnvelope
POST/v1/agent/leases/{lease_id}/ackagentLeaseAckAgent—AgentEnvelope → ControlPlaneEnvelope
POST/v1/agent/leases/{lease_id}/renewagentLeaseRenewAgent—AgentEnvelope → ControlPlaneEnvelope
POST/v1/agent/reportsagentReportAgent—AgentEnvelope → ControlPlaneEnvelope
GET/v1/sourceslistSourcesUsersource.read— → DataSourceDescriptor[]
POST/v1/sourcescreateSourceUsersource.registerDataSourceCreate → DataSourceDescriptor
GET/v1/sources/{source_id}getSourceUsersource.read— → DataSourceDescriptor
POST/v1/sources/{source_id}/sensitivity-attestationattestSourceSensitivityUsersource.attestSourceSensitivityAttestation → DataSourceDescriptor
POST/v1/sources/{source_id}/discoverdiscoverSource idempotentUserdiscovery.run— → Job
GET/v1/sources/{source_id}/schemagetSourceSchemaUsersource.read— → SchemaMetadata
GET/v1/findingslistFindingsUsersource.read— → SensitiveFieldFinding[]
POST/v1/findings/{finding_id}/reviewreviewFindingUserfinding.reviewFindingReview → SensitiveFieldFinding
GET/v1/policieslistPoliciesUserpolicy.read— → Policy[]
POST/v1/policiescreatePolicyUserpolicy.editPolicyCreate → Policy
GET/v1/policies/{policy_id}getPolicyUserpolicy.read— → Policy
GET/v1/policies/{policy_id}/versionslistPolicyVersionsUserpolicy.read— → PolicyVersion[]
POST/v1/policies/{policy_id}/versionscreatePolicyVersionUserpolicy.editPolicyVersionCreate → PolicyVersion
POST/v1/policies/{policy_id}/versions/{version}/submitsubmitPolicyVersionUserpolicy.edit— → PolicyVersion
POST/v1/policies/{policy_id}/versions/{version}/approveapprovePolicyVersionUserpolicy.approvePolicyApproval → PolicyVersion
GET/v1/policies/{policy_id}/versions/{version}/identity-validationvalidateIdentityGraphUserpolicy.read— → IdentityGraphValidation
POST/v1/identity-mapping/suggestionssuggestIdentityLinksUserpolicy.editIdentityLinkSuggestionRequest → IdentityLinkSuggestions
POST/v1/identity-mapping/planplanIdentityClosureUserdataset.readIdentityClosurePlanRequest → IdentityClosurePlan
GET/v1/masking-domainslistMaskingDomainsUserpolicy.read— → MaskingDomainEntry[]
POST/v1/policies/{policy_id}/versions/{version}/identity-overlaprequestIdentityOverlapUserdiscovery.runIdentityOverlapRequest → IdentityOverlapEvidence
GET/v1/policies/{policy_id}/versions/{version}/identity-overlaplistIdentityOverlapUserpolicy.read— → IdentityOverlapEvidence[]
POST/v1/policies/{policy_id}/versions/{version}/deprecatedeprecatePolicyVersionUserpolicy.approve— → PolicyVersion
POST/v1/policies/{policy_id}/versions/{version}/revokerevokePolicyVersionUserpolicy.approvePolicyRevocation → PolicyVersion
GET/v1/environmentslistEnvironmentsUserdataset.read— → Environment[]
POST/v1/environmentscreateEnvironmentUserenvironment.manageEnvironmentCreate → Environment
GET/v1/dataset-requestslistDatasetRequestsUserdataset.read— → DatasetRequest[]
POST/v1/dataset-requestscreateDatasetRequest idempotentUserdataset.requestDatasetRequestCreate → DatasetRequest
GET/v1/dataset-requests/{request_id}getDatasetRequestUserdataset.read— → DatasetRequest
POST/v1/dataset-requests/{request_id}/cancelcancelDatasetRequestUserdataset.request— → DatasetRequest
POST/v1/dataset-requests/{request_id}/approveapproveDatasetRequestUserdataset.approveDatasetRequestDecision → DatasetRequest
POST/v1/dataset-requests/{request_id}/rejectrejectDatasetRequestUserdataset.approveDatasetRequestDecision → DatasetRequest
GET/v1/datasetslistDatasetsUserdataset.read— → Dataset[]
GET/v1/datasets/{dataset_id}getDatasetUserdataset.read— → Dataset
GET/v1/datasets/{dataset_id}/versionslistDatasetVersionsUserdataset.read— → DatasetVersion[]
GET/v1/datasets/{dataset_id}/versions/{version}/manifestgetDatasetManifestUserdataset.read— → DatasetManifest
GET/v1/datasets/{dataset_id}/lineagegetDatasetLineageUserdataset.read— → LineageGraph
POST/v1/datasets/{dataset_id}/refreshrefreshDataset idempotentUserdataset.requestRefreshRequest → Job
POST/v1/datasets/{dataset_id}/versions/{version}/provisionprovisionDataset idempotentUserdataset.provisionProvisionRequest → Job
POST/v1/datasets/{dataset_id}/revokerevokeDatasetUserdataset.revokeDatasetRevocation → Dataset
POST/v1/datasets/{dataset_id}/versions/{version}/certification-reviewreviewDatasetCertificationUsercertification.reviewCertificationReviewDecision → DatasetVersion
POST/v1/datasets/{dataset_id}/rollbackrollbackDataset idempotentUserdataset.provisionRollbackRequest → Job
GET/v1/refresh-calendargetRefreshCalendarUserdataset.read— → RefreshCalendarEntry[]
GET/v1/jobslistJobsUserjob.read— → Job[]
GET/v1/jobs/{job_id}getJobUserjob.read— → Job
GET/v1/jobs/{job_id}/stepslistJobStepsUserjob.read— → JobStep[]
GET/v1/jobs/{job_id}/eventslistJobEventsUserjob.read— → JobEvent[]
POST/v1/jobs/{job_id}/cancelcancelJobUserjob.cancel— → Job
GET/v1/certification-reportslistCertificationReportsUserdataset.read— → CertificationReport[]
GET/v1/certification-reports/{report_id}getCertificationReportUserdataset.read— → CertificationReport
GET/v1/evidencelistEvidenceUserdataset.read— → EvidenceReference[]
GET/v1/audit-eventslistAuditEventsUseraudit.read— → AuditEvent[]
GET/v1/audit-events/verifyverifyAuditChainUseraudit.read— → AuditChainVerification
GET/v1/certificateslistCertificatesUserdataset.read— → CertificateSummary[]
GET/v1/certificates/{certificate_id}getCertificateUserdataset.read— → TestDataCertificate
GET/v1/certificates/{certificate_id}/statusgetCertificateStatusUserdataset.read— → CertificateStatusStatement
GET/v1/certificates/{certificate_id}/packagegetCertificatePackageUserdataset.read— → CertificateEvidencePackage
GET/v1/certificate-keyslistCertificateKeysPublic—— → CertificateKeySet
GET/v1/audit-exportexportAuditEvidenceUseraudit.read— → AuditEvidenceExport
GET/v1/industry-packslistIndustryPacksUser—— → IndustryPack[]
POST/v1/industry-packs/{pack_id}/enableenableIndustryPackUserpack.manage— → IndustryPack
POST/v1/industry-packs/{pack_id}/disabledisableIndustryPackUserpack.manage— → IndustryPack
GET/v1/industry-packs/{pack_id}getIndustryPackUser—— → IndustryPackDetail
POST/v1/industry-packs/{pack_id}/upgradeupgradeIndustryPackUserpack.managePackVersionChange → IndustryPack
POST/v1/industry-packs/{pack_id}/rollbackrollbackIndustryPackUserpack.manage— → IndustryPack
POST/v1/industry-packs/{pack_id}/policy-draftscreatePackPolicyDraftsUserpolicy.editPackPolicyDraftRequest → PackPolicyDrafts
GET/v1/entitlements/currentgetCurrentEntitlementUserbilling.read— → Entitlement
GET/v1/usagelistUsageUserbilling.read— → UsageMeter[]
POST/v1/billing/webhooks/{provider}receiveBillingWebhookprovider—— → WebhookAck
GET/v1/billing/subscriptiongetBillingSubscriptionUserbilling.read— → SubscriptionView
POST/v1/billing/checkoutcreateBillingCheckout idempotentUserbilling.manageCheckoutRequest → CheckoutResponse
POST/v1/billing/subscription/cancelcancelBillingSubscriptionUserbilling.manage— → SubscriptionView
GET/v1/billing/overviewgetBillingOverviewUserbilling.read— → BillingOverview
POST/v1/billing/portalcreateBillingPortalSessionUserbilling.manage— → BillingPortalSession
POST/v1/billing/subscription/changechangeBillingPlan idempotentUserbilling.managePlanChangeRequest → SubscriptionView
POST/v1/capacity/estimateestimateCapacityUser—CapacityEstimateRequest → CapacityEstimate
GET/v1/sandboxgetSandboxUser—— → SandboxView
POST/v1/sandboxcreateSandboxUseragent.manageSandboxCreate → SandboxView
POST/v1/sandbox/resetresetSandboxUseragent.manage— → SandboxView
POST/v1/sandbox/progressupdateSandboxProgressUser—SandboxProgressUpdate → SandboxView
POST/v1/sandbox-runner/claimsclaimSandboxWorkrunner—— → SandboxClaims
POST/v1/sandbox-runner/sandboxes/{sandbox_id}/reportreportSandboxStatusrunner—SandboxRunnerReport → SandboxRunnerAck
POST/v1/sandbox-runner/usagereportSandboxUsagerunner—SandboxUsageReport → SandboxUsageAck
GET/v1/reservationslistReservationsUserdataset.read— → DatasetReservation[]
POST/v1/reservationscreateReservationUserdataset.provisionDatasetReservationCreate → DatasetReservation
GET/v1/reservations/{reservation_id}getReservationUserdataset.read— → DatasetReservation
POST/v1/reservations/{reservation_id}/renewrenewReservationUserdataset.provisionDatasetReservationRenew → DatasetReservation
POST/v1/reservations/{reservation_id}/releasereleaseReservationUserdataset.provisionDatasetReservationRelease → DatasetReservation
GET/v1/environment-leaseslistEnvironmentLeasesUserdataset.read— → EnvironmentLease[]
POST/v1/environment-leasescreateEnvironmentLease idempotentUserdataset.provisionEnvironmentLeaseCreate → EnvironmentLease
GET/v1/environment-leases/{lease_id}getEnvironmentLeaseUserdataset.read— → EnvironmentLease
POST/v1/environment-leases/{lease_id}/renewrenewEnvironmentLeaseUserdataset.provisionEnvironmentLeaseRenew → EnvironmentLease
POST/v1/environment-leases/{lease_id}/releasereleaseEnvironmentLeaseUserdataset.provisionEnvironmentLeaseRelease → EnvironmentLease
GET/v1/environment-leases/{lease_id}/evidencegetEnvironmentLeaseEvidenceUserdataset.read— → EnvironmentLeaseEvidence
GET/v1/custom-schemaslistCustomSchemasUserpolicy.read— → CustomSchema[]
POST/v1/custom-schemascreateCustomSchemaUserpolicy.editCustomSchemaCreate → CustomSchema
GET/v1/custom-schemas/{custom_schema_id}getCustomSchemaUserpolicy.read— → CustomSchema
GET/v1/custom-schemas/{custom_schema_id}/versionslistCustomSchemaVersionsUserpolicy.read— → CustomSchemaVersion[]
POST/v1/custom-schemas/{custom_schema_id}/versionscreateCustomSchemaVersionUserpolicy.editCustomSchemaVersionCreate → CustomSchemaVersion
GET/v1/custom-schemas/{custom_schema_id}/versions/{version}getCustomSchemaVersionUserpolicy.read— → CustomSchemaVersion
POST/v1/custom-schemas/{custom_schema_id}/archivearchiveCustomSchemaUserpolicy.editCustomSchemaArchive → CustomSchema
GET/v1/test-data/profileslistTestDataProfilesUsertest_data.request— → TestDataProfileSummary[]
POST/v1/test-data/planplanTestDataRequestUsertest_data.requestTestDataRequestCreate → TestDataPlan
POST/v1/test-data/requestscreateTestDataRequest idempotentUsertest_data.requestTestDataRequestCreate → TestDataRequest
GET/v1/test-data/requestslistTestDataRequestsUsertest_data.request— → TestDataRequest[]
GET/v1/test-data/requests/{test_data_request_id}getTestDataRequestUsertest_data.request— → TestDataRequest
POST/v1/test-data/requests/{test_data_request_id}/approveapproveTestDataRequestUserdataset.approveTestDataRequestDecision → TestDataRequest
POST/v1/test-data/requests/{test_data_request_id}/rejectrejectTestDataRequestUserdataset.approveTestDataRequestDecision → TestDataRequest
POST/v1/test-data/requests/{test_data_request_id}/releasereleaseTestDataRequestUsertest_data.requestTestDataRequestRelease → TestDataRequest
GET/v1/dataset-requests/{request_id}/repro-bundlegetReproBundleUserdataset.read— → ReproBundle
POST/v1/dataset-requests/{request_id}/repro-bundle/leasecreateReproLease idempotentUserdataset.provisionReproLeaseCreate → EnvironmentLease
POST/v1/repro-revocationsrevokeReproByIssueUserdataset.revokeReproRevocation → ReproRevocationResult
GET/v1/eval-setslistEvalSetsUserdataset.read— → EvalSet[]
POST/v1/eval-setsregisterEvalSetUserdataset.requestEvalSetCreate → EvalSet
GET/v1/eval-sets/{eval_set_id}getEvalSetUserdataset.read— → EvalSet
GET/v1/eval-sets/{eval_set_id}/exportexportEvalSetUserdataset.read— → EvalSetExport
GET/v1/model-provider-policygetModelProviderPostureUserpolicy.read— → ModelProviderPosture
GET/v1/datasets/{dataset_id}/versions/{version}/document-setgetDatasetDocumentSetUserdataset.read— → DocumentSetSummary
GET/v1/compliance-guard/environmentslistGuardedEnvironmentsUserguard.read— → GuardedEnvironment[]
POST/v1/compliance-guard/environmentscreateGuardedEnvironment idempotentUserguard.manageGuardedEnvironmentCreate → GuardedEnvironment
GET/v1/compliance-guard/environments/{guarded_environment_id}getGuardedEnvironmentUserguard.read— → GuardedEnvironment
PATCH/v1/compliance-guard/environments/{guarded_environment_id}updateGuardedEnvironmentUserguard.manageGuardedEnvironmentUpdate → GuardedEnvironment
POST/v1/compliance-guard/environments/{guarded_environment_id}/scansrequestGuardScan idempotentUserguard.manageGuardScanRequest → GuardScan
POST/v1/compliance-guard/environments/{guarded_environment_id}/baselineacceptGuardBaselineUserguard.manageGuardBaselineAccept → GuardedEnvironment
GET/v1/compliance-guard/scanslistGuardScansUserguard.read— → GuardScan[]
GET/v1/compliance-guard/scans/{scan_id}getGuardScanUserguard.read— → GuardScan
GET/v1/compliance-guard/findingslistComplianceFindingsUserguard.read— → ComplianceFindingRecord[]
GET/v1/compliance-guard/findings/{compliance_finding_id}getComplianceFindingUserguard.read— → ComplianceFindingRecord
POST/v1/compliance-guard/findings/{compliance_finding_id}/acknowledgeacknowledgeComplianceFindingUserguard.triageGuardTriageRequest → ComplianceFindingRecord
POST/v1/compliance-guard/findings/{compliance_finding_id}/suppresssuppressComplianceFindingUserguard.triageGuardSuppressionCreate → ComplianceFindingRecord
POST/v1/compliance-guard/findings/{compliance_finding_id}/false-positivemarkComplianceFindingFalsePositiveUserguard.triageGuardTriageRequest → ComplianceFindingRecord
POST/v1/compliance-guard/findings/{compliance_finding_id}/reopenreopenComplianceFindingUserguard.triageGuardTriageRequest → ComplianceFindingRecord
GET/v1/compliance-guard/notification-channelslistNotificationChannelsUserguard.read— → NotificationChannel[]
POST/v1/compliance-guard/notification-channelscreateNotificationChannelUserguard.manageNotificationChannelCreate → NotificationChannel
PATCH/v1/compliance-guard/notification-channels/{channel_id}updateNotificationChannelUserguard.manageNotificationChannelUpdate → NotificationChannel
POST/v1/compliance-guard/notification-channels/{channel_id}/testtestNotificationChannelUserguard.manage— → GuardNotificationEvent
GET/v1/compliance-guard/trendgetComplianceGuardTrendUserguard.read— → GuardTrend
GET/v1/compliance-guard/guidancelistGuardGuidanceUserguard.read— → GuardGuidance[]
GET/v1/public/planslistPlansPublic—— → PlanOffer[]
POST/v1/public/leadssubmitLeadPublic—LeadSubmission → ReportAck
POST/v1/public/leads/form-tokensissueLeadFormTokenPublic—— → LeadFormToken
POST/v1/public/connector-interestsubmitConnectorInterestPublic—ConnectorInterest → ReportAck
POST/v1/public/feature-requestssubmitFeatureRequestPublic—FeatureRequestSubmission → ReportAck
POST/v1/feature-requestssubmitConsoleFeatureRequestUser—FeatureRequestSubmission → ReportAck

Read the API overview for authentication, errors, pagination and idempotency.