Access information from the CyberRisk platform programmatically using this API. You can find or generate an API key to access this API in your CyberRisk Account Settings. Please authorize all requests by setting the "Authorization" header to your api key. The base url for all public endpoints is https://cyber-risk.upguard.com/api/public
This Python package is automatically generated by the Swagger Codegen project:
- API version: 1.11.0
- Package version: 1.11.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com//.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com//.git
)
Then import the package:
import upguard
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import upguard
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import upguard
from upguard.rest import ApiException
from pprint import pprint
# Configure API key authorization: API key in header
configuration = upguard.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = upguard.BreachesApi(upguard.ApiClient(configuration))
page_token = 'page_token_example' # str | The `page_token` from a previous request, use this to get the next page of results. (optional)
page_size = 1000 # int | The number of results to return per page. (optional) (default to 1000)
sort_by = 'date_last_breach' # str | The value to sort the breached identities by If not specified will default to `date_last_breach` and set `sort_desc` to `true` (optional) (default to date_last_breach)
sort_desc = false # bool | Whether or not to sort the results in descending order (optional) (default to false)
breach_id = 'breach_id_example' # str | The breach ID to filter on (optional)
try:
# Get a list of breached identities
api_response = api_instance.breached_identities(page_token=page_token, page_size=page_size, sort_by=sort_by, sort_desc=sort_desc, breach_id=breach_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling BreachesApi->breached_identities: %s\n" % e)
All URIs are relative to https://cyber-risk.upguard.com/api/public
Class | Method | HTTP request | Description |
---|---|---|---|
BreachesApi | breached_identities | GET /breaches | Get a list of breached identities |
BreachesApi | identity_breach | GET /breach | Get the details for an identity breach |
BulkApi | bulk_deregister_hostnames | DELETE /bulk/hostnames | Deregister a list of hostnames |
BulkApi | bulk_get_hostname_details | GET /bulk/hostnames/{hostname} | Get the details for a hostname |
BulkApi | bulk_get_hostnames_stats | GET /bulk/hostnames/stats | Get statistics around registered bulk hostnames |
BulkApi | bulk_hostname_put_labels | PUT /bulk/hostnames/{hostname}/labels | Assign new labels to a hostname |
BulkApi | bulk_list_hostnames | GET /bulk/hostnames | List hostnames and their risks |
BulkApi | bulk_register_hostnames | POST /bulk/hostnames | Register a list of hostnames to be scanned for risks |
DataleaksApi | dataleaks_disclosures | GET /dataleaks/disclosures | Get a list of disclosures |
DataleaksApi | dataleaks_disclosures_update_status | PUT /dataleaks/disclosures/status | Update the status of a disclosure |
DomainsApi | add_custom_domains | PUT /domains | Add custom domains |
DomainsApi | domain_details | GET /domain | Retrieve details for a domain |
DomainsApi | domain_update_labels | PUT /domain/labels | Assign labels to a domain |
DomainsApi | domains | GET /domains | Get a list of domains |
DomainsApi | remove_custom_domains | DELETE /domains | Remove custom domains |
IpsApi | add_custom_ips | PUT /ips | Add custom ips |
IpsApi | ip_details | GET /ip | Retrieve details for an IP address |
IpsApi | ip_update_labels | PUT /ip/labels | Assign labels to an IP |
IpsApi | ips | GET /ips | Get a list of ips |
IpsApi | ranges | GET /ranges | Get a list of ip ranges |
IpsApi | remove_custom_ips | DELETE /ips | Remove custom ips |
LabelsApi | labels | GET /labels | Get the list of registered labels |
OrganisationApi | get_organisation_v1 | GET /organisation | Get the current organisation |
RisksApi | available_risks | GET /available_risks | Get a list of available risks in the platform |
RisksApi | available_risks_v2 | GET /available_risks/v2 | Get a list of available risks in the platform |
RisksApi | org_risks_diff | GET /risks/diff | Get a list of risk changes for your account |
RisksApi | risk | GET /available_risks/risk | Get details for a risk in the platform |
RisksApi | risks | GET /risks | Get a list of active risks for your account |
RisksApi | vendor_questionnaire_risks | GET /risks/vendors/questionnaires | Get a list of questionnaire risks for one or more watched vendors or a specific questionnaire |
RisksApi | vendor_questionnaire_risks_v2 | GET /risks/vendors/questionnaires/v2 | (V2) Get a list of questionnaire risks for one or more watched vendors or a specific questionnaire |
RisksApi | vendor_risks | GET /risks/vendors | Get a list of active risks for a vendor |
RisksApi | vendor_risks_diff | GET /risks/vendors/diff | Get a list of risk changes for a vendor |
RisksApi | vendors_risks_diff | GET /risks/vendors/diffs | Get a list of risk changes for monitored vendors |
SubsidiariesApi | subsidiaries | GET /subsidiaries | Get a list of subsidiaries |
SubsidiariesApi | subsidiary_domain_details | GET /subsidiary/domain | Retrieve details for a domain |
SubsidiariesApi | subsidiary_domain_update_labels | PUT /subsidiary/domain/labels | Assign labels to an domain |
SubsidiariesApi | subsidiary_domains | GET /subsidiary/domains | List subsidiary domains |
SubsidiariesApi | subsidiary_ip_details | GET /subsidiary/ip | Retrieve details for an IP address |
SubsidiariesApi | subsidiary_ip_update_labels | PUT /subsidiary/ip/labels | Assign labels to an IP |
SubsidiariesApi | subsidiary_ips | GET /subsidiary/ips | List subdiary ips |
SubsidiariesApi | subsidiary_ranges | GET /subsidiary/ranges | List subsidiary ip ranges |
TyposquatApi | list_typosquat_domains | GET /typosquat | List typosquat domains |
TyposquatApi | typosquat_details | GET /typosquat/details | Retrieve typosquat details for a domain. |
VendorsApi | additional_evidence | GET /vendor/additionalevidence | Retrieve (one or more) vendor additional evidence documents by id |
VendorsApi | additional_evidences_list | GET /vendor/additionalevidence/list | List vendor additional evidence instances |
VendorsApi | attachment | GET /vendor/questionnaire/attachment | Retrieve (one or more) vendor questionnaire attachments by id |
VendorsApi | attachments | GET /vendor/questionnaire/attachment/list | List vendor questionnaire attachments |
VendorsApi | document | GET /vendor/document | Retrieve (one or more) vendor documents by id |
VendorsApi | documents | GET /vendor/documents | List vendor documents |
VendorsApi | questionnaires | GET /vendor/questionnaires | List vendor questionnaires |
VendorsApi | questionnaires_v2 | GET /vendor/questionnaires/v2 | List vendor questionnaires |
VendorsApi | vendor | GET /vendor | Get vendor details |
VendorsApi | vendor_domain_details | GET /vendor/domain | Retrieve details for a domain |
VendorsApi | vendor_domain_update_labels | PUT /vendor/domain/labels | Assign labels to an domain |
VendorsApi | vendor_domains | GET /vendor/domains | List vendor domains |
VendorsApi | vendor_ip_details | GET /vendor/ip | Retrieve details for an IP address |
VendorsApi | vendor_ip_update_labels | PUT /vendor/ip/labels | Assign labels to an IP |
VendorsApi | vendor_ips | GET /vendor/ips | List vendor ips |
VendorsApi | vendor_ranges | GET /vendor/ranges | List vendor ip ranges |
VendorsApi | vendor_update_attributes | PUT /vendor/attributes | Assign or update the attributes for a vendor |
VendorsApi | vendor_update_labels | PUT /vendor/labels | Assign labels to a vendor |
VendorsApi | vendor_update_tier | PUT /vendor/tier | Assign tier to a vendor |
VendorsApi | vendors | GET /vendors | List monitored vendors |
VulnerabilitiesApi | org_vulnerabilities | GET /vulnerabilities | List potential vulnerabilities of your domains & IPs |
VulnerabilitiesApi | vendor_vulnerabilities | GET /vulnerabilities/vendor | List potential vulnerabilities of a vendor |
WebhooksApi | create_webhook | POST /webhooks | Create a new webhook |
WebhooksApi | delete_webhook | DELETE /webhooks | Delete a webhook |
WebhooksApi | list_webhooks | GET /webhooks | List webhooks |
WebhooksApi | sample_webhook | GET /webhooks/sample | Webhook example data |
WebhooksApi | webhooks_notification_types | GET /webhooks/notification_types | Webhook notification types |
- Account
- AccountHierarchy
- AdditionalEvidencesList
- ApiRange
- AvailableRisk
- AvailableRiskV2
- Breach
- BreachedIdentitiesResponsePayloadBody
- BreachedIdentity
- BulkDeregisterHostnamesV1RequestBody
- BulkDeregisterHostnamesV1ResponseBody
- BulkGetHostnamesStatsV1ResponseBody
- BulkHostname
- BulkListHostnamesV1ResponseBody
- BulkRegisterHostnamesV1RequestBody
- BulkRegisterHostnamesV1ResponseBody
- BulkRisk
- BulkVendor
- Category
- CategoryScores
- CheckResult
- CreateWebhookResponsePayload
- Cve
- DataLeaksDisclosure
- DataLeaksDisclosuresResponsePayloadBody
- DeleteWebhookResponsePayload
- Diff
- DiffStatus
- Diffs
- Document
- Domain
- DomainScore
- Endpoint300Error
- EndpointError
- ExampleDataWebhookResponsePayload
- File
- FileHeader
- GetDomainDetailsV1RespBody
- GetDomainsV1RespBody
- GetIPsV1RespBody
- GetIpDetailsV1RespBody
- GetLabelsV1RespBody
- GetOrgVulnerabilitiesV1RespBody
- GetOrganisationV1RespBody
- GetRangesV1RespBody
- GetRisksV1RespBody
- GetSubsidiariesV1RespBody
- GetTyposquatDetailsResponsePayloadBody
- GetTyposquatResponsePayloadBody
- GetVendorAdditionalEvidenceResponsePayload
- GetVendorAdditionalEvidencesResponsePayload
- GetVendorAttachmentResponsePayload
- GetVendorDocumentResponsePayload
- GetVendorDocumentsResponsePayload
- GetVendorQuestionnaireAttachmentsResponsePayload
- GetVendorQuestionnairesV1ResponsePayload
- GetVendorQuestionnairesV2ResponsePayload
- GetVendorVulnerabilitiesV1RespBody
- GetWebhookNotificationTypesResponsePayload
- IP
- IPSource
- IdentityBreachResponsePayloadBody
- ListWebhookResponsePayload
- MIMEHeader
- ModelProperty
- MonitoredVendor
- NotificationType
- PermutationType
- Questionnaire
- QuestionnaireRisk
- QuestionnaireRiskV2
- QuestionnaireRiskWaiver
- QuestionnaireRisksResponsePayloadBody
- QuestionnaireRisksResponsePayloadBodyV2
- Risk
- RiskDiff
- RiskDiffGroup
- RiskWaiver
- RisksDiffResponsePayloadBody
- ScanDiff
- ScanResult
- Severity
- SharedQuestionnaire
- StringSlice
- SummaryDiff
- SummaryDiffGroup
- TyposquatDomain
- TyposquatPermutationDetail
- UpdateVendorAttributesV1RequestBody
- Vendor
- VendorDiff
- VendorQuestionnaireAttachment
- VendorsResponsePayloadBody
- VendorsRisk
- VendorsRiskDiffs
- VendorsRisksDiffResponsePayloadBody
- Vulnerability
- Webhook
- WebhookSampleData
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header