@censys/platform-sdk 0.9.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -13
- package/docs/sdks/accountmanagement/README.md +113 -9
- package/docs/sdks/collections/README.md +22 -14
- package/docs/sdks/globaldata/README.md +27 -14
- package/docs/sdks/threathunting/README.md +11 -6
- package/examples/package-lock.json +3 -3
- package/funcs/accountManagementGetMemberCreditUsage.d.ts +2 -2
- package/funcs/accountManagementGetMemberCreditUsage.js +8 -3
- package/funcs/accountManagementGetMemberCreditUsage.js.map +1 -1
- package/funcs/accountManagementGetOrganizationCreditUsage.d.ts +1 -1
- package/funcs/accountManagementGetOrganizationCreditUsage.js +8 -2
- package/funcs/accountManagementGetOrganizationCreditUsage.js.map +1 -1
- package/funcs/accountManagementGetOrganizationCredits.d.ts +1 -1
- package/funcs/accountManagementGetOrganizationCredits.js +4 -2
- package/funcs/accountManagementGetOrganizationCredits.js.map +1 -1
- package/funcs/accountManagementGetOrganizationDetails.js +3 -1
- package/funcs/accountManagementGetOrganizationDetails.js.map +1 -1
- package/funcs/accountManagementGetUserCredits.d.ts +2 -2
- package/funcs/accountManagementGetUserCredits.js +5 -3
- package/funcs/accountManagementGetUserCredits.js.map +1 -1
- package/funcs/accountManagementGetUserCreditsUsage.d.ts +18 -0
- package/funcs/accountManagementGetUserCreditsUsage.d.ts.map +1 -0
- package/funcs/accountManagementGetUserCreditsUsage.js +131 -0
- package/funcs/accountManagementGetUserCreditsUsage.js.map +1 -0
- package/funcs/accountManagementInviteUserToOrganization.js +4 -2
- package/funcs/accountManagementInviteUserToOrganization.js.map +1 -1
- package/funcs/accountManagementListOrganizationMembers.js +4 -2
- package/funcs/accountManagementListOrganizationMembers.js.map +1 -1
- package/funcs/accountManagementRemoveOrganizationMember.js +3 -1
- package/funcs/accountManagementRemoveOrganizationMember.js.map +1 -1
- package/funcs/accountManagementUpdateOrganizationMember.js +4 -2
- package/funcs/accountManagementUpdateOrganizationMember.js.map +1 -1
- package/funcs/collectionsAggregate.js +4 -2
- package/funcs/collectionsAggregate.js.map +1 -1
- package/funcs/collectionsCreate.d.ts +1 -1
- package/funcs/collectionsCreate.js +5 -3
- package/funcs/collectionsCreate.js.map +1 -1
- package/funcs/collectionsDelete.d.ts +1 -1
- package/funcs/collectionsDelete.js +5 -3
- package/funcs/collectionsDelete.js.map +1 -1
- package/funcs/collectionsGet.d.ts +1 -1
- package/funcs/collectionsGet.js +5 -3
- package/funcs/collectionsGet.js.map +1 -1
- package/funcs/collectionsList.d.ts +1 -1
- package/funcs/collectionsList.js +5 -3
- package/funcs/collectionsList.js.map +1 -1
- package/funcs/collectionsListEvents.d.ts +1 -1
- package/funcs/collectionsListEvents.js +5 -3
- package/funcs/collectionsListEvents.js.map +1 -1
- package/funcs/collectionsSearch.js +4 -2
- package/funcs/collectionsSearch.js.map +1 -1
- package/funcs/collectionsUpdate.d.ts +1 -1
- package/funcs/collectionsUpdate.js +5 -3
- package/funcs/collectionsUpdate.js.map +1 -1
- package/funcs/globalDataAggregate.js +4 -2
- package/funcs/globalDataAggregate.js.map +1 -1
- package/funcs/globalDataConvertLegacySearchQueries.js +2 -2
- package/funcs/globalDataConvertLegacySearchQueries.js.map +1 -1
- package/funcs/globalDataCreateTrackedScan.js +4 -2
- package/funcs/globalDataCreateTrackedScan.js.map +1 -1
- package/funcs/globalDataGetCertificate.js +4 -2
- package/funcs/globalDataGetCertificate.js.map +1 -1
- package/funcs/globalDataGetCertificateRaw.js +4 -2
- package/funcs/globalDataGetCertificateRaw.js.map +1 -1
- package/funcs/globalDataGetCertificates.js +4 -2
- package/funcs/globalDataGetCertificates.js.map +1 -1
- package/funcs/globalDataGetCertificatesRaw.js +4 -2
- package/funcs/globalDataGetCertificatesRaw.js.map +1 -1
- package/funcs/globalDataGetHost.js +4 -2
- package/funcs/globalDataGetHost.js.map +1 -1
- package/funcs/globalDataGetHostTimeline.js +4 -2
- package/funcs/globalDataGetHostTimeline.js.map +1 -1
- package/funcs/globalDataGetHosts.js +4 -2
- package/funcs/globalDataGetHosts.js.map +1 -1
- package/funcs/globalDataGetTrackedScan.js +4 -2
- package/funcs/globalDataGetTrackedScan.js.map +1 -1
- package/funcs/globalDataGetWebProperties.js +4 -2
- package/funcs/globalDataGetWebProperties.js.map +1 -1
- package/funcs/globalDataGetWebProperty.js +4 -2
- package/funcs/globalDataGetWebProperty.js.map +1 -1
- package/funcs/globalDataSearch.js +4 -2
- package/funcs/globalDataSearch.js.map +1 -1
- package/funcs/threatHuntingCreateTrackedScan.js +4 -2
- package/funcs/threatHuntingCreateTrackedScan.js.map +1 -1
- package/funcs/threatHuntingGetHostObservationsWithCertificate.js +4 -2
- package/funcs/threatHuntingGetHostObservationsWithCertificate.js.map +1 -1
- package/funcs/threatHuntingGetTrackedScanThreatHunting.js +4 -2
- package/funcs/threatHuntingGetTrackedScanThreatHunting.js.map +1 -1
- package/funcs/threatHuntingListThreats.d.ts +1 -1
- package/funcs/threatHuntingListThreats.js +5 -3
- package/funcs/threatHuntingListThreats.js.map +1 -1
- package/funcs/threatHuntingValueCounts.js +4 -2
- package/funcs/threatHuntingValueCounts.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.js +4 -4
- package/lib/config.js.map +1 -1
- package/lib/sdks.js +2 -2
- package/lib/sdks.js.map +1 -1
- package/models/components/alternativequery.d.ts +3 -3
- package/models/components/alternativequery.d.ts.map +1 -1
- package/models/components/alternativequery.js +2 -2
- package/models/components/alternativequery.js.map +1 -1
- package/models/components/attribute.d.ts +4 -3
- package/models/components/attribute.d.ts.map +1 -1
- package/models/components/attribute.js +3 -2
- package/models/components/attribute.js.map +1 -1
- package/models/components/certificate.d.ts +5 -5
- package/models/components/certificate.d.ts.map +1 -1
- package/models/components/certificate.js +3 -3
- package/models/components/certificate.js.map +1 -1
- package/models/components/certificaterevocationrevocationinfo.d.ts +3 -3
- package/models/components/certificaterevocationrevocationinfo.d.ts.map +1 -1
- package/models/components/certificaterevocationrevocationinfo.js +2 -2
- package/models/components/certificaterevocationrevocationinfo.js.map +1 -1
- package/models/components/collection.d.ts +9 -5
- package/models/components/collection.d.ts.map +1 -1
- package/models/components/collection.js +5 -2
- package/models/components/collection.js.map +1 -1
- package/models/components/creditexpiration.d.ts +4 -0
- package/models/components/creditexpiration.d.ts.map +1 -1
- package/models/components/creditexpiration.js +2 -0
- package/models/components/creditexpiration.js.map +1 -1
- package/models/components/creditusagereport.d.ts +44 -5
- package/models/components/creditusagereport.d.ts.map +1 -1
- package/models/components/creditusagereport.js +28 -7
- package/models/components/creditusagereport.js.map +1 -1
- package/models/components/creditusagereportperiod.d.ts +33 -0
- package/models/components/creditusagereportperiod.d.ts.map +1 -0
- package/models/components/creditusagereportperiod.js +65 -0
- package/models/components/creditusagereportperiod.js.map +1 -0
- package/models/components/cvsscomponents.d.ts +17 -17
- package/models/components/cvsscomponents.d.ts.map +1 -1
- package/models/components/cvsscomponents.js +9 -9
- package/models/components/cvsscomponents.js.map +1 -1
- package/models/components/cvssv4components.d.ts +29 -29
- package/models/components/cvssv4components.d.ts.map +1 -1
- package/models/components/cvssv4components.js +15 -17
- package/models/components/cvssv4components.js.map +1 -1
- package/models/components/dns.d.ts +5 -5
- package/models/components/dns.d.ts.map +1 -1
- package/models/components/dns.js +3 -3
- package/models/components/dns.js.map +1 -1
- package/models/components/dnsresourcerecord.d.ts +3 -3
- package/models/components/dnsresourcerecord.d.ts.map +1 -1
- package/models/components/dnsresourcerecord.js +2 -1
- package/models/components/dnsresourcerecord.js.map +1 -1
- package/models/components/endpointscan.d.ts +3 -3
- package/models/components/endpointscan.d.ts.map +1 -1
- package/models/components/endpointscan.js +2 -1
- package/models/components/endpointscan.js.map +1 -1
- package/models/components/endpointscanstate.d.ts +5 -3
- package/models/components/endpointscanstate.d.ts.map +1 -1
- package/models/components/endpointscanstate.js +4 -1
- package/models/components/endpointscanstate.js.map +1 -1
- package/models/components/eventassetchange.d.ts +3 -3
- package/models/components/eventassetchange.d.ts.map +1 -1
- package/models/components/eventassetchange.js +2 -2
- package/models/components/eventassetchange.js.map +1 -1
- package/models/components/eventstatuschange.d.ts +5 -5
- package/models/components/eventstatuschange.d.ts.map +1 -1
- package/models/components/eventstatuschange.js +3 -4
- package/models/components/eventstatuschange.js.map +1 -1
- package/models/components/extractedendpointdata.d.ts +17 -0
- package/models/components/extractedendpointdata.d.ts.map +1 -0
- package/models/components/extractedendpointdata.js +65 -0
- package/models/components/extractedendpointdata.js.map +1 -0
- package/models/components/extractedendpointdataanalyticsservice.d.ts +11 -0
- package/models/components/extractedendpointdataanalyticsservice.d.ts.map +1 -0
- package/models/components/extractedendpointdataanalyticsservice.js +51 -0
- package/models/components/extractedendpointdataanalyticsservice.js.map +1 -0
- package/models/components/extractedendpointdatacopyright.d.ts +13 -0
- package/models/components/extractedendpointdatacopyright.d.ts.map +1 -0
- package/models/components/extractedendpointdatacopyright.js +59 -0
- package/models/components/extractedendpointdatacopyright.js.map +1 -0
- package/models/components/flashsocketpolicy.d.ts +13 -0
- package/models/components/flashsocketpolicy.d.ts.map +1 -0
- package/models/components/flashsocketpolicy.js +59 -0
- package/models/components/flashsocketpolicy.js.map +1 -0
- package/models/components/flashsocketpolicyallowaccessfrom.d.ts +12 -0
- package/models/components/flashsocketpolicyallowaccessfrom.d.ts.map +1 -0
- package/models/components/flashsocketpolicyallowaccessfrom.js +57 -0
- package/models/components/flashsocketpolicyallowaccessfrom.js.map +1 -0
- package/models/components/gemini.d.ts +13 -0
- package/models/components/gemini.d.ts.map +1 -0
- package/models/components/gemini.js +60 -0
- package/models/components/gemini.js.map +1 -0
- package/models/components/greynoise.d.ts +22 -0
- package/models/components/greynoise.d.ts.map +1 -0
- package/models/components/greynoise.js +53 -0
- package/models/components/greynoise.js.map +1 -0
- package/models/components/greynoisetag.d.ts +13 -0
- package/models/components/greynoisetag.d.ts.map +1 -0
- package/models/components/greynoisetag.js +50 -0
- package/models/components/greynoisetag.js.map +1 -0
- package/models/components/hajime.d.ts +10 -0
- package/models/components/hajime.d.ts.map +1 -0
- package/models/components/hajime.js +56 -0
- package/models/components/hajime.js.map +1 -0
- package/models/components/host.d.ts +2 -0
- package/models/components/host.d.ts.map +1 -1
- package/models/components/host.js +2 -0
- package/models/components/host.js.map +1 -1
- package/models/components/hostdnsforwardresolution.d.ts +3 -3
- package/models/components/hostdnsforwardresolution.d.ts.map +1 -1
- package/models/components/hostdnsforwardresolution.js +2 -2
- package/models/components/hostdnsforwardresolution.js.map +1 -1
- package/models/components/http.d.ts +7 -0
- package/models/components/http.d.ts.map +1 -1
- package/models/components/http.js +7 -0
- package/models/components/http.js.map +1 -1
- package/models/components/httpredirectchainlink.d.ts +26 -0
- package/models/components/httpredirectchainlink.d.ts.map +1 -0
- package/models/components/httpredirectchainlink.js +71 -0
- package/models/components/httpredirectchainlink.js.map +1 -0
- package/models/components/index.d.ts +26 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +26 -0
- package/models/components/index.js.map +1 -1
- package/models/components/jarmscan.d.ts +3 -3
- package/models/components/jarmscan.d.ts.map +1 -1
- package/models/components/jarmscan.js +2 -1
- package/models/components/jarmscan.js.map +1 -1
- package/models/components/kev.d.ts +3 -3
- package/models/components/kev.d.ts.map +1 -1
- package/models/components/kev.js +2 -2
- package/models/components/kev.js.map +1 -1
- package/models/components/label.d.ts +4 -3
- package/models/components/label.d.ts.map +1 -1
- package/models/components/label.js +3 -2
- package/models/components/label.js.map +1 -1
- package/models/components/matchedservice.d.ts +3 -3
- package/models/components/matchedservice.d.ts.map +1 -1
- package/models/components/matchedservice.js +2 -1
- package/models/components/matchedservice.js.map +1 -1
- package/models/components/mavlink.d.ts +12 -0
- package/models/components/mavlink.d.ts.map +1 -0
- package/models/components/mavlink.js +57 -0
- package/models/components/mavlink.js.map +1 -0
- package/models/components/mavlinkframe.d.ts +15 -0
- package/models/components/mavlinkframe.d.ts.map +1 -0
- package/models/components/mavlinkframe.js +63 -0
- package/models/components/mavlinkframe.js.map +1 -0
- package/models/components/melsec.d.ts +10 -0
- package/models/components/melsec.d.ts.map +1 -0
- package/models/components/melsec.js +56 -0
- package/models/components/melsec.js.map +1 -0
- package/models/components/memberlist.d.ts +15 -0
- package/models/components/memberlist.d.ts.map +1 -0
- package/models/components/memberlist.js +62 -0
- package/models/components/memberlist.js.map +1 -0
- package/models/components/memberlistnodeinfo.d.ts +16 -0
- package/models/components/memberlistnodeinfo.d.ts.map +1 -0
- package/models/components/memberlistnodeinfo.js +62 -0
- package/models/components/memberlistnodeinfo.js.map +1 -0
- package/models/components/networklog.d.ts +18 -0
- package/models/components/networklog.d.ts.map +1 -0
- package/models/components/networklog.js +58 -0
- package/models/components/networklog.js.map +1 -0
- package/models/components/networklogresourceinfo.d.ts +49 -0
- package/models/components/networklogresourceinfo.d.ts.map +1 -0
- package/models/components/networklogresourceinfo.js +64 -0
- package/models/components/networklogresourceinfo.js.map +1 -0
- package/models/components/paginationinfo.d.ts +1 -1
- package/models/components/reject.d.ts +3 -3
- package/models/components/reject.d.ts.map +1 -1
- package/models/components/reject.js +2 -2
- package/models/components/reject.js.map +1 -1
- package/models/components/representativeinfo.d.ts +3 -3
- package/models/components/representativeinfo.d.ts.map +1 -1
- package/models/components/representativeinfo.js +2 -1
- package/models/components/representativeinfo.js.map +1 -1
- package/models/components/risk.d.ts +8 -7
- package/models/components/risk.d.ts.map +1 -1
- package/models/components/risk.js +5 -6
- package/models/components/risk.js.map +1 -1
- package/models/components/rootstore.d.ts +3 -3
- package/models/components/rootstore.d.ts.map +1 -1
- package/models/components/rootstore.js +2 -1
- package/models/components/rootstore.js.map +1 -1
- package/models/components/routerosapi.d.ts +12 -0
- package/models/components/routerosapi.d.ts.map +1 -0
- package/models/components/routerosapi.js +58 -0
- package/models/components/routerosapi.js.map +1 -0
- package/models/components/rustdeskheartbeat.d.ts +12 -0
- package/models/components/rustdeskheartbeat.d.ts.map +1 -0
- package/models/components/rustdeskheartbeat.js +59 -0
- package/models/components/rustdeskheartbeat.js.map +1 -0
- package/models/components/rustdeskheartbeatregisterpeerresponse.d.ts +10 -0
- package/models/components/rustdeskheartbeatregisterpeerresponse.d.ts.map +1 -0
- package/models/components/rustdeskheartbeatregisterpeerresponse.js +55 -0
- package/models/components/rustdeskheartbeatregisterpeerresponse.js.map +1 -0
- package/models/components/rustdeskrelay.d.ts +10 -0
- package/models/components/rustdeskrelay.d.ts.map +1 -0
- package/models/components/rustdeskrelay.js +55 -0
- package/models/components/rustdeskrelay.js.map +1 -0
- package/models/components/rustdeskrendezvous.d.ts +14 -0
- package/models/components/rustdeskrendezvous.d.ts.map +1 -0
- package/models/components/rustdeskrendezvous.js +61 -0
- package/models/components/rustdeskrendezvous.js.map +1 -0
- package/models/components/rustdeskrendezvousconfigupdate.d.ts +11 -0
- package/models/components/rustdeskrendezvousconfigupdate.d.ts.map +1 -0
- package/models/components/rustdeskrendezvousconfigupdate.js +56 -0
- package/models/components/rustdeskrendezvousconfigupdate.js.map +1 -0
- package/models/components/rustdeskrendezvouskeyexchange.d.ts +10 -0
- package/models/components/rustdeskrendezvouskeyexchange.d.ts.map +1 -0
- package/models/components/rustdeskrendezvouskeyexchange.js +50 -0
- package/models/components/rustdeskrendezvouskeyexchange.js.map +1 -0
- package/models/components/rustdeskrendezvoustestnatresponse.d.ts +12 -0
- package/models/components/rustdeskrendezvoustestnatresponse.d.ts.map +1 -0
- package/models/components/rustdeskrendezvoustestnatresponse.js +57 -0
- package/models/components/rustdeskrendezvoustestnatresponse.js.map +1 -0
- package/models/components/screenshot.d.ts +1 -0
- package/models/components/screenshot.d.ts.map +1 -1
- package/models/components/screenshot.js +1 -0
- package/models/components/screenshot.js.map +1 -1
- package/models/components/searchconvertqueryresponse.d.ts +3 -3
- package/models/components/searchconvertqueryresponse.d.ts.map +1 -1
- package/models/components/searchconvertqueryresponse.js +2 -1
- package/models/components/searchconvertqueryresponse.js.map +1 -1
- package/models/components/searchqueryinputbody.d.ts +1 -1
- package/models/components/service.d.ts +23 -3
- package/models/components/service.d.ts.map +1 -1
- package/models/components/service.js +27 -1
- package/models/components/service.js.map +1 -1
- package/models/components/serviceid.d.ts +3 -3
- package/models/components/serviceid.d.ts.map +1 -1
- package/models/components/serviceid.js +2 -1
- package/models/components/serviceid.js.map +1 -1
- package/models/components/servicescan.d.ts +23 -3
- package/models/components/servicescan.d.ts.map +1 -1
- package/models/components/servicescan.js +27 -1
- package/models/components/servicescan.js.map +1 -1
- package/models/components/sourceusagebreakdown.d.ts +9 -1
- package/models/components/sourceusagebreakdown.d.ts.map +1 -1
- package/models/components/sourceusagebreakdown.js +7 -0
- package/models/components/sourceusagebreakdown.js.map +1 -1
- package/models/components/threat.d.ts +4 -3
- package/models/components/threat.d.ts.map +1 -1
- package/models/components/threat.js +3 -1
- package/models/components/threat.js.map +1 -1
- package/models/components/tls.d.ts +3 -3
- package/models/components/tls.d.ts.map +1 -1
- package/models/components/tls.js +2 -1
- package/models/components/tls.js.map +1 -1
- package/models/components/tlsversiondata.d.ts +3 -3
- package/models/components/tlsversiondata.d.ts.map +1 -1
- package/models/components/tlsversiondata.js +2 -2
- package/models/components/tlsversiondata.js.map +1 -1
- package/models/components/trackedscantask.d.ts +3 -3
- package/models/components/trackedscantask.d.ts.map +1 -1
- package/models/components/trackedscantask.js +2 -1
- package/models/components/trackedscantask.js.map +1 -1
- package/models/components/vuln.d.ts +8 -7
- package/models/components/vuln.d.ts.map +1 -1
- package/models/components/vuln.js +5 -4
- package/models/components/vuln.js.map +1 -1
- package/models/operations/index.d.ts +1 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +1 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/v3accountmanagementmembercreditsusage.d.ts +33 -3
- package/models/operations/v3accountmanagementmembercreditsusage.d.ts.map +1 -1
- package/models/operations/v3accountmanagementmembercreditsusage.js +17 -2
- package/models/operations/v3accountmanagementmembercreditsusage.js.map +1 -1
- package/models/operations/v3accountmanagementorgcreditsusage.d.ts +38 -3
- package/models/operations/v3accountmanagementorgcreditsusage.d.ts.map +1 -1
- package/models/operations/v3accountmanagementorgcreditsusage.js +20 -2
- package/models/operations/v3accountmanagementorgcreditsusage.js.map +1 -1
- package/models/operations/v3accountmanagementusercreditsusage.d.ts +57 -0
- package/models/operations/v3accountmanagementusercreditsusage.d.ts.map +1 -0
- package/models/operations/v3accountmanagementusercreditsusage.js +85 -0
- package/models/operations/v3accountmanagementusercreditsusage.js.map +1 -0
- package/package.json +3 -3
- package/sdk/accountmanagement.d.ts +13 -6
- package/sdk/accountmanagement.d.ts.map +1 -1
- package/sdk/accountmanagement.js +16 -6
- package/sdk/accountmanagement.js.map +1 -1
- package/sdk/collections.d.ts +6 -6
- package/sdk/collections.js +6 -6
- package/sdk/threathunting.d.ts +1 -1
- package/sdk/threathunting.js +1 -1
- package/src/funcs/accountManagementGetMemberCreditUsage.ts +9 -3
- package/src/funcs/accountManagementGetOrganizationCreditUsage.ts +9 -2
- package/src/funcs/accountManagementGetOrganizationCredits.ts +5 -2
- package/src/funcs/accountManagementGetOrganizationDetails.ts +4 -1
- package/src/funcs/accountManagementGetUserCredits.ts +6 -3
- package/src/funcs/accountManagementGetUserCreditsUsage.ts +193 -0
- package/src/funcs/accountManagementInviteUserToOrganization.ts +5 -2
- package/src/funcs/accountManagementListOrganizationMembers.ts +5 -2
- package/src/funcs/accountManagementRemoveOrganizationMember.ts +4 -1
- package/src/funcs/accountManagementUpdateOrganizationMember.ts +5 -2
- package/src/funcs/collectionsAggregate.ts +5 -2
- package/src/funcs/collectionsCreate.ts +6 -3
- package/src/funcs/collectionsDelete.ts +6 -3
- package/src/funcs/collectionsGet.ts +6 -3
- package/src/funcs/collectionsList.ts +6 -3
- package/src/funcs/collectionsListEvents.ts +6 -3
- package/src/funcs/collectionsSearch.ts +5 -2
- package/src/funcs/collectionsUpdate.ts +6 -3
- package/src/funcs/globalDataAggregate.ts +5 -2
- package/src/funcs/globalDataConvertLegacySearchQueries.ts +2 -2
- package/src/funcs/globalDataCreateTrackedScan.ts +5 -2
- package/src/funcs/globalDataGetCertificate.ts +5 -2
- package/src/funcs/globalDataGetCertificateRaw.ts +5 -2
- package/src/funcs/globalDataGetCertificates.ts +5 -2
- package/src/funcs/globalDataGetCertificatesRaw.ts +5 -2
- package/src/funcs/globalDataGetHost.ts +5 -2
- package/src/funcs/globalDataGetHostTimeline.ts +5 -2
- package/src/funcs/globalDataGetHosts.ts +5 -2
- package/src/funcs/globalDataGetTrackedScan.ts +5 -2
- package/src/funcs/globalDataGetWebProperties.ts +5 -2
- package/src/funcs/globalDataGetWebProperty.ts +5 -2
- package/src/funcs/globalDataSearch.ts +5 -2
- package/src/funcs/threatHuntingCreateTrackedScan.ts +5 -2
- package/src/funcs/threatHuntingGetHostObservationsWithCertificate.ts +5 -2
- package/src/funcs/threatHuntingGetTrackedScanThreatHunting.ts +5 -2
- package/src/funcs/threatHuntingListThreats.ts +6 -3
- package/src/funcs/threatHuntingValueCounts.ts +5 -2
- package/src/lib/config.ts +4 -4
- package/src/lib/sdks.ts +2 -2
- package/src/models/components/alternativequery.ts +5 -4
- package/src/models/components/attribute.ts +6 -4
- package/src/models/components/certificate.ts +14 -8
- package/src/models/components/certificaterevocationrevocationinfo.ts +5 -4
- package/src/models/components/collection.ts +20 -8
- package/src/models/components/creditexpiration.ts +6 -0
- package/src/models/components/creditusagereport.ts +70 -11
- package/src/models/components/creditusagereportperiod.ts +69 -0
- package/src/models/components/cvsscomponents.ts +47 -30
- package/src/models/components/cvssv4components.ts +83 -53
- package/src/models/components/dns.ts +11 -8
- package/src/models/components/dnsresourcerecord.ts +8 -5
- package/src/models/components/endpointscan.ts +8 -5
- package/src/models/components/endpointscanstate.ts +14 -5
- package/src/models/components/eventassetchange.ts +8 -4
- package/src/models/components/eventstatuschange.ts +14 -7
- package/src/models/components/extractedendpointdata.ts +62 -0
- package/src/models/components/extractedendpointdataanalyticsservice.ts +34 -0
- package/src/models/components/extractedendpointdatacopyright.ts +43 -0
- package/src/models/components/flashsocketpolicy.ts +47 -0
- package/src/models/components/flashsocketpolicyallowaccessfrom.ts +40 -0
- package/src/models/components/gemini.ts +40 -0
- package/src/models/components/greynoise.ts +45 -0
- package/src/models/components/greynoisetag.ts +34 -0
- package/src/models/components/hajime.ts +33 -0
- package/src/models/components/host.ts +3 -0
- package/src/models/components/hostdnsforwardresolution.ts +8 -4
- package/src/models/components/http.ts +15 -0
- package/src/models/components/httpredirectchainlink.ts +67 -0
- package/src/models/components/index.ts +26 -0
- package/src/models/components/jarmscan.ts +8 -5
- package/src/models/components/kev.ts +8 -4
- package/src/models/components/label.ts +9 -4
- package/src/models/components/matchedservice.ts +8 -5
- package/src/models/components/mavlink.ts +36 -0
- package/src/models/components/mavlinkframe.ts +49 -0
- package/src/models/components/melsec.ts +33 -0
- package/src/models/components/memberlist.ts +50 -0
- package/src/models/components/memberlistnodeinfo.ts +49 -0
- package/src/models/components/networklog.ts +49 -0
- package/src/models/components/networklogresourceinfo.ts +84 -0
- package/src/models/components/paginationinfo.ts +1 -1
- package/src/models/components/reject.ts +8 -4
- package/src/models/components/representativeinfo.ts +8 -5
- package/src/models/components/risk.ts +21 -10
- package/src/models/components/rootstore.ts +5 -5
- package/src/models/components/routerosapi.ts +41 -0
- package/src/models/components/rustdeskheartbeat.ts +44 -0
- package/src/models/components/rustdeskheartbeatregisterpeerresponse.ts +37 -0
- package/src/models/components/rustdeskrelay.ts +36 -0
- package/src/models/components/rustdeskrendezvous.ts +50 -0
- package/src/models/components/rustdeskrendezvousconfigupdate.ts +38 -0
- package/src/models/components/rustdeskrendezvouskeyexchange.ts +31 -0
- package/src/models/components/rustdeskrendezvoustestnatresponse.ts +42 -0
- package/src/models/components/screenshot.ts +2 -0
- package/src/models/components/searchconvertqueryresponse.ts +8 -5
- package/src/models/components/searchqueryinputbody.ts +1 -1
- package/src/models/components/service.ts +52 -5
- package/src/models/components/serviceid.ts +8 -5
- package/src/models/components/servicescan.ts +52 -5
- package/src/models/components/sourceusagebreakdown.ts +16 -1
- package/src/models/components/threat.ts +9 -4
- package/src/models/components/tls.ts +8 -5
- package/src/models/components/tlsversiondata.ts +5 -4
- package/src/models/components/trackedscantask.ts +8 -5
- package/src/models/components/vuln.ts +21 -11
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/v3accountmanagementmembercreditsusage.ts +43 -4
- package/src/models/operations/v3accountmanagementorgcreditsusage.ts +49 -4
- package/src/models/operations/v3accountmanagementusercreditsusage.ts +128 -0
- package/src/sdk/accountmanagement.ts +24 -6
- package/src/sdk/collections.ts +6 -6
- package/src/sdk/threathunting.ts +1 -1
package/README.md
CHANGED
|
@@ -114,14 +114,15 @@ run();
|
|
|
114
114
|
### [AccountManagement](docs/sdks/accountmanagement/README.md)
|
|
115
115
|
|
|
116
116
|
* [getOrganizationDetails](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
|
|
117
|
-
* [getOrganizationCredits](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit
|
|
117
|
+
* [getOrganizationCredits](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit balance
|
|
118
118
|
* [getOrganizationCreditUsage](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
|
|
119
119
|
* [inviteUserToOrganization](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
|
|
120
120
|
* [listOrganizationMembers](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
|
|
121
121
|
* [removeOrganizationMember](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
|
|
122
122
|
* [updateOrganizationMember](docs/sdks/accountmanagement/README.md#updateorganizationmember) - Update a member's roles in an organization
|
|
123
|
-
* [getMemberCreditUsage](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
|
|
124
|
-
* [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit
|
|
123
|
+
* [getMemberCreditUsage](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get organization member credit usage
|
|
124
|
+
* [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance
|
|
125
|
+
* [getUserCreditsUsage](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage
|
|
125
126
|
|
|
126
127
|
### [Collections](docs/sdks/collections/README.md)
|
|
127
128
|
|
|
@@ -177,11 +178,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
177
178
|
|
|
178
179
|
<summary>Available standalone functions</summary>
|
|
179
180
|
|
|
180
|
-
- [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
|
|
181
|
-
- [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit
|
|
181
|
+
- [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get organization member credit usage
|
|
182
|
+
- [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit balance
|
|
182
183
|
- [`accountManagementGetOrganizationCreditUsage`](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
|
|
183
184
|
- [`accountManagementGetOrganizationDetails`](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
|
|
184
|
-
- [`accountManagementGetUserCredits`](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit
|
|
185
|
+
- [`accountManagementGetUserCredits`](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance
|
|
186
|
+
- [`accountManagementGetUserCreditsUsage`](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage
|
|
185
187
|
- [`accountManagementInviteUserToOrganization`](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
|
|
186
188
|
- [`accountManagementListOrganizationMembers`](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
|
|
187
189
|
- [`accountManagementRemoveOrganizationMember`](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
|
|
@@ -437,19 +439,23 @@ The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
|
|
437
439
|
used to integrate a third-party HTTP client or when writing tests to mock out
|
|
438
440
|
the HTTP client and feed in fixtures.
|
|
439
441
|
|
|
440
|
-
The following example shows how to
|
|
441
|
-
|
|
442
|
-
to
|
|
442
|
+
The following example shows how to:
|
|
443
|
+
- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
|
|
444
|
+
- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
|
|
445
|
+
- use the `"requestError"` hook to log errors
|
|
443
446
|
|
|
444
447
|
```typescript
|
|
445
448
|
import { SDK } from "@censys/platform-sdk";
|
|
449
|
+
import { ProxyAgent } from "undici";
|
|
446
450
|
import { HTTPClient } from "@censys/platform-sdk/lib/http";
|
|
447
451
|
|
|
452
|
+
const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
|
|
453
|
+
|
|
448
454
|
const httpClient = new HTTPClient({
|
|
449
|
-
// fetcher takes a function that has the same signature as native
|
|
450
|
-
fetcher: (
|
|
451
|
-
|
|
452
|
-
|
|
455
|
+
// 'fetcher' takes a function that has the same signature as native 'fetch'.
|
|
456
|
+
fetcher: (input, init) =>
|
|
457
|
+
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
|
|
458
|
+
fetch(input, { ...init, dispatcher } as RequestInit),
|
|
453
459
|
});
|
|
454
460
|
|
|
455
461
|
httpClient.addHook("beforeRequest", (request) => {
|
|
@@ -7,14 +7,15 @@ Endpoints related to the Account Management product
|
|
|
7
7
|
### Available Operations
|
|
8
8
|
|
|
9
9
|
* [getOrganizationDetails](#getorganizationdetails) - Get organization details
|
|
10
|
-
* [getOrganizationCredits](#getorganizationcredits) - Get organization credit
|
|
10
|
+
* [getOrganizationCredits](#getorganizationcredits) - Get organization credit balance
|
|
11
11
|
* [getOrganizationCreditUsage](#getorganizationcreditusage) - Get organization credit usage
|
|
12
12
|
* [inviteUserToOrganization](#inviteusertoorganization) - Invite user to organization
|
|
13
13
|
* [listOrganizationMembers](#listorganizationmembers) - List organization members
|
|
14
14
|
* [removeOrganizationMember](#removeorganizationmember) - Remove member from organization
|
|
15
15
|
* [updateOrganizationMember](#updateorganizationmember) - Update a member's roles in an organization
|
|
16
|
-
* [getMemberCreditUsage](#getmembercreditusage) - Get member credit usage
|
|
17
|
-
* [getUserCredits](#getusercredits) - Get Free user credit
|
|
16
|
+
* [getMemberCreditUsage](#getmembercreditusage) - Get organization member credit usage
|
|
17
|
+
* [getUserCredits](#getusercredits) - Get Free user credit balance
|
|
18
|
+
* [getUserCreditsUsage](#getusercreditsusage) - Get Free user credit usage
|
|
18
19
|
|
|
19
20
|
## getOrganizationDetails
|
|
20
21
|
|
|
@@ -89,6 +90,7 @@ run();
|
|
|
89
90
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
90
91
|
| errors.AuthenticationError | 401 | application/json |
|
|
91
92
|
| errors.ErrorModel | 403, 404, 422 | application/problem+json |
|
|
93
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
92
94
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
93
95
|
|
|
94
96
|
## getOrganizationCredits
|
|
@@ -164,17 +166,19 @@ run();
|
|
|
164
166
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
165
167
|
| errors.AuthenticationError | 401 | application/json |
|
|
166
168
|
| errors.ErrorModel | 403, 404, 422 | application/problem+json |
|
|
169
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
167
170
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
168
171
|
|
|
169
172
|
## getOrganizationCreditUsage
|
|
170
173
|
|
|
171
|
-
Retrieve credit
|
|
174
|
+
Retrieve credit information for an organization over a specific date range. You must include a start date in your request.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
|
|
172
175
|
|
|
173
176
|
### Example Usage
|
|
174
177
|
|
|
175
178
|
<!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-org-credits-usage" method="get" path="/v3/accounts/organizations/{organization_id}/credits/usage" -->
|
|
176
179
|
```typescript
|
|
177
180
|
import { SDK } from "@censys/platform-sdk";
|
|
181
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
178
182
|
|
|
179
183
|
const sdk = new SDK({
|
|
180
184
|
personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
@@ -184,6 +188,8 @@ async function run() {
|
|
|
184
188
|
const result = await sdk.accountManagement.getOrganizationCreditUsage({
|
|
185
189
|
organizationId: "11111111-2222-3333-4444-555555555555",
|
|
186
190
|
date: "2025-11-01",
|
|
191
|
+
startDate: new RFCDate("2025-11-01"),
|
|
192
|
+
endDate: new RFCDate("2025-12-01"),
|
|
187
193
|
});
|
|
188
194
|
|
|
189
195
|
console.log(result);
|
|
@@ -199,6 +205,7 @@ The standalone function version of this method:
|
|
|
199
205
|
```typescript
|
|
200
206
|
import { SDKCore } from "@censys/platform-sdk/core.js";
|
|
201
207
|
import { accountManagementGetOrganizationCreditUsage } from "@censys/platform-sdk/funcs/accountManagementGetOrganizationCreditUsage.js";
|
|
208
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
202
209
|
|
|
203
210
|
// Use `SDKCore` for best tree-shaking performance.
|
|
204
211
|
// You can create one instance of it to use across an application.
|
|
@@ -210,6 +217,8 @@ async function run() {
|
|
|
210
217
|
const res = await accountManagementGetOrganizationCreditUsage(sdk, {
|
|
211
218
|
organizationId: "11111111-2222-3333-4444-555555555555",
|
|
212
219
|
date: "2025-11-01",
|
|
220
|
+
startDate: new RFCDate("2025-11-01"),
|
|
221
|
+
endDate: new RFCDate("2025-12-01"),
|
|
213
222
|
});
|
|
214
223
|
if (res.ok) {
|
|
215
224
|
const { value: result } = res;
|
|
@@ -241,6 +250,7 @@ run();
|
|
|
241
250
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
242
251
|
| errors.AuthenticationError | 401 | application/json |
|
|
243
252
|
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
253
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
244
254
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
245
255
|
|
|
246
256
|
## inviteUserToOrganization
|
|
@@ -321,7 +331,8 @@ run();
|
|
|
321
331
|
| Error Type | Status Code | Content Type |
|
|
322
332
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
323
333
|
| errors.AuthenticationError | 401 | application/json |
|
|
324
|
-
| errors.ErrorModel | 403, 404, 422
|
|
334
|
+
| errors.ErrorModel | 403, 404, 409, 422 | application/problem+json |
|
|
335
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
325
336
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
326
337
|
|
|
327
338
|
## listOrganizationMembers
|
|
@@ -396,7 +407,8 @@ run();
|
|
|
396
407
|
| Error Type | Status Code | Content Type |
|
|
397
408
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
398
409
|
| errors.AuthenticationError | 401 | application/json |
|
|
399
|
-
| errors.ErrorModel | 403, 404
|
|
410
|
+
| errors.ErrorModel | 403, 404, 422 | application/problem+json |
|
|
411
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
400
412
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
401
413
|
|
|
402
414
|
## removeOrganizationMember
|
|
@@ -474,6 +486,7 @@ run();
|
|
|
474
486
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
475
487
|
| errors.AuthenticationError | 401 | application/json |
|
|
476
488
|
| errors.ErrorModel | 403, 404, 409, 422 | application/problem+json |
|
|
489
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
477
490
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
478
491
|
|
|
479
492
|
## updateOrganizationMember
|
|
@@ -556,18 +569,20 @@ run();
|
|
|
556
569
|
| Error Type | Status Code | Content Type |
|
|
557
570
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
558
571
|
| errors.AuthenticationError | 401 | application/json |
|
|
559
|
-
| errors.ErrorModel | 400, 403, 404, 422
|
|
572
|
+
| errors.ErrorModel | 400, 403, 404, 409, 422 | application/problem+json |
|
|
573
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
560
574
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
561
575
|
|
|
562
576
|
## getMemberCreditUsage
|
|
563
577
|
|
|
564
|
-
Retrieve credit consumption information for an organization member
|
|
578
|
+
Retrieve credit consumption information for an organization member over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
|
|
565
579
|
|
|
566
580
|
### Example Usage
|
|
567
581
|
|
|
568
582
|
<!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-member-credits-usage" method="get" path="/v3/accounts/organizations/{organization_id}/members/{user_id}/credits/usage" -->
|
|
569
583
|
```typescript
|
|
570
584
|
import { SDK } from "@censys/platform-sdk";
|
|
585
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
571
586
|
|
|
572
587
|
const sdk = new SDK({
|
|
573
588
|
personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
@@ -578,6 +593,8 @@ async function run() {
|
|
|
578
593
|
organizationId: "11111111-2222-3333-4444-555555555555",
|
|
579
594
|
userId: "11111111-2222-3333-4444-555555555555",
|
|
580
595
|
date: "2025-11-01",
|
|
596
|
+
startDate: new RFCDate("2025-11-01"),
|
|
597
|
+
endDate: new RFCDate("2025-12-01"),
|
|
581
598
|
});
|
|
582
599
|
|
|
583
600
|
console.log(result);
|
|
@@ -593,6 +610,7 @@ The standalone function version of this method:
|
|
|
593
610
|
```typescript
|
|
594
611
|
import { SDKCore } from "@censys/platform-sdk/core.js";
|
|
595
612
|
import { accountManagementGetMemberCreditUsage } from "@censys/platform-sdk/funcs/accountManagementGetMemberCreditUsage.js";
|
|
613
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
596
614
|
|
|
597
615
|
// Use `SDKCore` for best tree-shaking performance.
|
|
598
616
|
// You can create one instance of it to use across an application.
|
|
@@ -605,6 +623,8 @@ async function run() {
|
|
|
605
623
|
organizationId: "11111111-2222-3333-4444-555555555555",
|
|
606
624
|
userId: "11111111-2222-3333-4444-555555555555",
|
|
607
625
|
date: "2025-11-01",
|
|
626
|
+
startDate: new RFCDate("2025-11-01"),
|
|
627
|
+
endDate: new RFCDate("2025-12-01"),
|
|
608
628
|
});
|
|
609
629
|
if (res.ok) {
|
|
610
630
|
const { value: result } = res;
|
|
@@ -636,11 +656,12 @@ run();
|
|
|
636
656
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
637
657
|
| errors.AuthenticationError | 401 | application/json |
|
|
638
658
|
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
659
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
639
660
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
640
661
|
|
|
641
662
|
## getUserCredits
|
|
642
663
|
|
|
643
|
-
Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit
|
|
664
|
+
Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit balance endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This endpoint does not cost any credits to execute.
|
|
644
665
|
|
|
645
666
|
### Example Usage
|
|
646
667
|
|
|
@@ -706,4 +727,87 @@ run();
|
|
|
706
727
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
707
728
|
| errors.AuthenticationError | 401 | application/json |
|
|
708
729
|
| errors.ErrorModel | 404 | application/problem+json |
|
|
730
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
731
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
732
|
+
|
|
733
|
+
## getUserCreditsUsage
|
|
734
|
+
|
|
735
|
+
Retrieve your Free user account credit consumption information over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
|
|
736
|
+
|
|
737
|
+
### Example Usage
|
|
738
|
+
|
|
739
|
+
<!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-user-credits-usage" method="get" path="/v3/accounts/users/credits/usage" -->
|
|
740
|
+
```typescript
|
|
741
|
+
import { SDK } from "@censys/platform-sdk";
|
|
742
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
743
|
+
|
|
744
|
+
const sdk = new SDK({
|
|
745
|
+
personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
746
|
+
});
|
|
747
|
+
|
|
748
|
+
async function run() {
|
|
749
|
+
const result = await sdk.accountManagement.getUserCreditsUsage({
|
|
750
|
+
date: "2025-11-01",
|
|
751
|
+
startDate: new RFCDate("2025-11-01"),
|
|
752
|
+
endDate: new RFCDate("2025-12-01"),
|
|
753
|
+
});
|
|
754
|
+
|
|
755
|
+
console.log(result);
|
|
756
|
+
}
|
|
757
|
+
|
|
758
|
+
run();
|
|
759
|
+
```
|
|
760
|
+
|
|
761
|
+
### Standalone function
|
|
762
|
+
|
|
763
|
+
The standalone function version of this method:
|
|
764
|
+
|
|
765
|
+
```typescript
|
|
766
|
+
import { SDKCore } from "@censys/platform-sdk/core.js";
|
|
767
|
+
import { accountManagementGetUserCreditsUsage } from "@censys/platform-sdk/funcs/accountManagementGetUserCreditsUsage.js";
|
|
768
|
+
import { RFCDate } from "@censys/platform-sdk/types";
|
|
769
|
+
|
|
770
|
+
// Use `SDKCore` for best tree-shaking performance.
|
|
771
|
+
// You can create one instance of it to use across an application.
|
|
772
|
+
const sdk = new SDKCore({
|
|
773
|
+
personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
774
|
+
});
|
|
775
|
+
|
|
776
|
+
async function run() {
|
|
777
|
+
const res = await accountManagementGetUserCreditsUsage(sdk, {
|
|
778
|
+
date: "2025-11-01",
|
|
779
|
+
startDate: new RFCDate("2025-11-01"),
|
|
780
|
+
endDate: new RFCDate("2025-12-01"),
|
|
781
|
+
});
|
|
782
|
+
if (res.ok) {
|
|
783
|
+
const { value: result } = res;
|
|
784
|
+
console.log(result);
|
|
785
|
+
} else {
|
|
786
|
+
console.log("accountManagementGetUserCreditsUsage failed:", res.error);
|
|
787
|
+
}
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
run();
|
|
791
|
+
```
|
|
792
|
+
|
|
793
|
+
### Parameters
|
|
794
|
+
|
|
795
|
+
| Parameter | Type | Required | Description |
|
|
796
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
797
|
+
| `request` | [operations.V3AccountmanagementUserCreditsUsageRequest](../../models/operations/v3accountmanagementusercreditsusagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
798
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
799
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
800
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
801
|
+
|
|
802
|
+
### Response
|
|
803
|
+
|
|
804
|
+
**Promise\<[operations.V3AccountmanagementUserCreditsUsageResponse](../../models/operations/v3accountmanagementusercreditsusageresponse.md)\>**
|
|
805
|
+
|
|
806
|
+
### Errors
|
|
807
|
+
|
|
808
|
+
| Error Type | Status Code | Content Type |
|
|
809
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
810
|
+
| errors.AuthenticationError | 401 | application/json |
|
|
811
|
+
| errors.ErrorModel | 400, 404 | application/problem+json |
|
|
812
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
709
813
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -17,7 +17,7 @@ Endpoints related to the Collections product
|
|
|
17
17
|
|
|
18
18
|
## list
|
|
19
19
|
|
|
20
|
-
List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
|
|
20
|
+
List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
|
|
21
21
|
|
|
22
22
|
### Example Usage
|
|
23
23
|
|
|
@@ -91,12 +91,13 @@ run();
|
|
|
91
91
|
| Error Type | Status Code | Content Type |
|
|
92
92
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
93
93
|
| errors.AuthenticationError | 401 | application/json |
|
|
94
|
-
| errors.ErrorModel | 403
|
|
94
|
+
| errors.ErrorModel | 400, 403 | application/problem+json |
|
|
95
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
95
96
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
96
97
|
|
|
97
98
|
## create
|
|
98
99
|
|
|
99
|
-
Create a new collection.
|
|
100
|
+
Create a new collection.<br><br>This endpoint does not cost credits to execute.
|
|
100
101
|
|
|
101
102
|
### Example Usage
|
|
102
103
|
|
|
@@ -176,12 +177,13 @@ run();
|
|
|
176
177
|
| Error Type | Status Code | Content Type |
|
|
177
178
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
178
179
|
| errors.AuthenticationError | 401 | application/json |
|
|
179
|
-
| errors.ErrorModel | 403
|
|
180
|
+
| errors.ErrorModel | 400, 403, 409, 412, 422 | application/problem+json |
|
|
181
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
180
182
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
181
183
|
|
|
182
184
|
## delete
|
|
183
185
|
|
|
184
|
-
Delete a collection.
|
|
186
|
+
Delete a collection.<br><br>This endpoint does not cost credits to execute.
|
|
185
187
|
|
|
186
188
|
### Example Usage
|
|
187
189
|
|
|
@@ -253,12 +255,13 @@ run();
|
|
|
253
255
|
| Error Type | Status Code | Content Type |
|
|
254
256
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
255
257
|
| errors.AuthenticationError | 401 | application/json |
|
|
256
|
-
| errors.ErrorModel | 403, 404
|
|
258
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
259
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
257
260
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
258
261
|
|
|
259
262
|
## get
|
|
260
263
|
|
|
261
|
-
Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
|
|
264
|
+
Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
|
|
262
265
|
|
|
263
266
|
### Example Usage
|
|
264
267
|
|
|
@@ -330,12 +333,13 @@ run();
|
|
|
330
333
|
| Error Type | Status Code | Content Type |
|
|
331
334
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
332
335
|
| errors.AuthenticationError | 401 | application/json |
|
|
333
|
-
| errors.ErrorModel | 403, 404
|
|
336
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
337
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
334
338
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
335
339
|
|
|
336
340
|
## update
|
|
337
341
|
|
|
338
|
-
Update a collection's name, description, and/or query.
|
|
342
|
+
Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.
|
|
339
343
|
|
|
340
344
|
### Example Usage
|
|
341
345
|
|
|
@@ -417,12 +421,13 @@ run();
|
|
|
417
421
|
| Error Type | Status Code | Content Type |
|
|
418
422
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
419
423
|
| errors.AuthenticationError | 401 | application/json |
|
|
420
|
-
| errors.ErrorModel | 403, 404
|
|
424
|
+
| errors.ErrorModel | 400, 403, 404, 412 | application/problem+json |
|
|
425
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
421
426
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
422
427
|
|
|
423
428
|
## listEvents
|
|
424
429
|
|
|
425
|
-
Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
|
|
430
|
+
Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.<br><br>This endpoint does not cost credits to execute.
|
|
426
431
|
|
|
427
432
|
### Example Usage
|
|
428
433
|
|
|
@@ -502,7 +507,8 @@ run();
|
|
|
502
507
|
| Error Type | Status Code | Content Type |
|
|
503
508
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
504
509
|
| errors.AuthenticationError | 401 | application/json |
|
|
505
|
-
| errors.ErrorModel | 403, 404
|
|
510
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
511
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
506
512
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
507
513
|
|
|
508
514
|
## aggregate
|
|
@@ -589,7 +595,8 @@ run();
|
|
|
589
595
|
| Error Type | Status Code | Content Type |
|
|
590
596
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
591
597
|
| errors.AuthenticationError | 401 | application/json |
|
|
592
|
-
| errors.ErrorModel | 403, 404, 422
|
|
598
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
599
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
593
600
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
594
601
|
|
|
595
602
|
## search
|
|
@@ -680,5 +687,6 @@ run();
|
|
|
680
687
|
| Error Type | Status Code | Content Type |
|
|
681
688
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
682
689
|
| errors.AuthenticationError | 401 | application/json |
|
|
683
|
-
| errors.ErrorModel | 403, 404
|
|
690
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
691
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
684
692
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -103,7 +103,8 @@ run();
|
|
|
103
103
|
| Error Type | Status Code | Content Type |
|
|
104
104
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
105
105
|
| errors.AuthenticationError | 401 | application/json |
|
|
106
|
-
| errors.ErrorModel | 403, 404
|
|
106
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
107
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
107
108
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
108
109
|
|
|
109
110
|
## getCertificatesRaw
|
|
@@ -188,7 +189,8 @@ run();
|
|
|
188
189
|
| Error Type | Status Code | Content Type |
|
|
189
190
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
190
191
|
| errors.AuthenticationError | 401 | application/json |
|
|
191
|
-
| errors.ErrorModel | 403, 404
|
|
192
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
193
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
192
194
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
193
195
|
|
|
194
196
|
## getCertificate
|
|
@@ -265,7 +267,8 @@ run();
|
|
|
265
267
|
| Error Type | Status Code | Content Type |
|
|
266
268
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
267
269
|
| errors.AuthenticationError | 401 | application/json |
|
|
268
|
-
| errors.ErrorModel | 403, 404
|
|
270
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
271
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
269
272
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
270
273
|
|
|
271
274
|
## getCertificateRaw
|
|
@@ -342,7 +345,8 @@ run();
|
|
|
342
345
|
| Error Type | Status Code | Content Type |
|
|
343
346
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
344
347
|
| errors.AuthenticationError | 401 | application/json |
|
|
345
|
-
| errors.ErrorModel | 403, 404
|
|
348
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
349
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
346
350
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
347
351
|
|
|
348
352
|
## getHosts
|
|
@@ -429,7 +433,8 @@ run();
|
|
|
429
433
|
| Error Type | Status Code | Content Type |
|
|
430
434
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
431
435
|
| errors.AuthenticationError | 401 | application/json |
|
|
432
|
-
| errors.ErrorModel | 403
|
|
436
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
437
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
433
438
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
434
439
|
|
|
435
440
|
## getHost
|
|
@@ -508,7 +513,8 @@ run();
|
|
|
508
513
|
| Error Type | Status Code | Content Type |
|
|
509
514
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
510
515
|
| errors.AuthenticationError | 401 | application/json |
|
|
511
|
-
| errors.ErrorModel | 403, 404
|
|
516
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
517
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
512
518
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
513
519
|
|
|
514
520
|
## getHostTimeline
|
|
@@ -589,7 +595,8 @@ run();
|
|
|
589
595
|
| Error Type | Status Code | Content Type |
|
|
590
596
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
591
597
|
| errors.AuthenticationError | 401 | application/json |
|
|
592
|
-
| errors.ErrorModel | 403
|
|
598
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
599
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
593
600
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
594
601
|
|
|
595
602
|
## getWebProperties
|
|
@@ -676,7 +683,8 @@ run();
|
|
|
676
683
|
| Error Type | Status Code | Content Type |
|
|
677
684
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
678
685
|
| errors.AuthenticationError | 401 | application/json |
|
|
679
|
-
| errors.ErrorModel | 403
|
|
686
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
687
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
680
688
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
681
689
|
|
|
682
690
|
## getWebProperty
|
|
@@ -755,7 +763,8 @@ run();
|
|
|
755
763
|
| Error Type | Status Code | Content Type |
|
|
756
764
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
757
765
|
| errors.AuthenticationError | 401 | application/json |
|
|
758
|
-
| errors.ErrorModel | 403, 422
|
|
766
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
767
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
759
768
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
760
769
|
|
|
761
770
|
## createTrackedScan
|
|
@@ -846,7 +855,8 @@ run();
|
|
|
846
855
|
| Error Type | Status Code | Content Type |
|
|
847
856
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
848
857
|
| errors.AuthenticationError | 401 | application/json |
|
|
849
|
-
| errors.ErrorModel | 403
|
|
858
|
+
| errors.ErrorModel | 400, 403, 422 | application/problem+json |
|
|
859
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
850
860
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
851
861
|
|
|
852
862
|
## getTrackedScan
|
|
@@ -923,7 +933,8 @@ run();
|
|
|
923
933
|
| Error Type | Status Code | Content Type |
|
|
924
934
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
925
935
|
| errors.AuthenticationError | 401 | application/json |
|
|
926
|
-
| errors.ErrorModel | 403, 404
|
|
936
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
937
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
927
938
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
928
939
|
|
|
929
940
|
## aggregate
|
|
@@ -1008,7 +1019,8 @@ run();
|
|
|
1008
1019
|
| Error Type | Status Code | Content Type |
|
|
1009
1020
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
1010
1021
|
| errors.AuthenticationError | 401 | application/json |
|
|
1011
|
-
| errors.ErrorModel | 403, 422
|
|
1022
|
+
| errors.ErrorModel | 400, 403, 422 | application/problem+json |
|
|
1023
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1012
1024
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1013
1025
|
|
|
1014
1026
|
## convertLegacySearchQueries
|
|
@@ -1097,7 +1109,7 @@ run();
|
|
|
1097
1109
|
| Error Type | Status Code | Content Type |
|
|
1098
1110
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
1099
1111
|
| errors.AuthenticationError | 401 | application/json |
|
|
1100
|
-
| errors.ErrorModel | 403
|
|
1112
|
+
| errors.ErrorModel | 400, 403 | application/problem+json |
|
|
1101
1113
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1102
1114
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1103
1115
|
|
|
@@ -1187,5 +1199,6 @@ run();
|
|
|
1187
1199
|
| Error Type | Status Code | Content Type |
|
|
1188
1200
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
1189
1201
|
| errors.AuthenticationError | 401 | application/json |
|
|
1190
|
-
| errors.ErrorModel | 403
|
|
1202
|
+
| errors.ErrorModel | 400, 403, 422 | application/problem+json |
|
|
1203
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1191
1204
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -96,7 +96,8 @@ run();
|
|
|
96
96
|
| Error Type | Status Code | Content Type |
|
|
97
97
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
98
98
|
| errors.AuthenticationError | 401 | application/json |
|
|
99
|
-
| errors.ErrorModel | 403
|
|
99
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
100
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
100
101
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
101
102
|
|
|
102
103
|
## createTrackedScan
|
|
@@ -187,7 +188,8 @@ run();
|
|
|
187
188
|
| Error Type | Status Code | Content Type |
|
|
188
189
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
189
190
|
| errors.AuthenticationError | 401 | application/json |
|
|
190
|
-
| errors.ErrorModel | 403
|
|
191
|
+
| errors.ErrorModel | 400, 403, 422 | application/problem+json |
|
|
192
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
191
193
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
192
194
|
|
|
193
195
|
## getTrackedScanThreatHunting
|
|
@@ -264,12 +266,13 @@ run();
|
|
|
264
266
|
| Error Type | Status Code | Content Type |
|
|
265
267
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
266
268
|
| errors.AuthenticationError | 401 | application/json |
|
|
267
|
-
| errors.ErrorModel | 403, 404
|
|
269
|
+
| errors.ErrorModel | 400, 403, 404 | application/problem+json |
|
|
270
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
268
271
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
269
272
|
|
|
270
273
|
## listThreats
|
|
271
274
|
|
|
272
|
-
Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).
|
|
275
|
+
Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Threat Hunting module.
|
|
273
276
|
|
|
274
277
|
### Example Usage
|
|
275
278
|
|
|
@@ -341,7 +344,8 @@ run();
|
|
|
341
344
|
| Error Type | Status Code | Content Type |
|
|
342
345
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
343
346
|
| errors.AuthenticationError | 401 | application/json |
|
|
344
|
-
| errors.ErrorModel | 403, 422
|
|
347
|
+
| errors.ErrorModel | 400, 403, 422 | application/problem+json |
|
|
348
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
345
349
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
346
350
|
|
|
347
351
|
## valueCounts
|
|
@@ -446,5 +450,6 @@ run();
|
|
|
446
450
|
| Error Type | Status Code | Content Type |
|
|
447
451
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
448
452
|
| errors.AuthenticationError | 401 | application/json |
|
|
449
|
-
| errors.ErrorModel | 403
|
|
453
|
+
| errors.ErrorModel | 400, 403, 422 | application/problem+json |
|
|
454
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
450
455
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|