components: schemas: Activemq: additionalProperties: false properties: cache_enabled: type: boolean cache_size: format: int32 type: integer max_frame_size: format: int64 type: integer max_inactivity_duration: format: int64 type: integer max_inactivity_duration_initial_delay: format: int32 type: integer platform_details: type: string provider_name: type: string provider_version: type: string size_prefix_disabled: type: boolean stack_trace_enabled: type: boolean tcp_no_delay_enabled: type: boolean tight_encoding_enabled: type: boolean type: object ActorInfo: additionalProperties: false properties: email: description: The email of the entity that performed the action. type: string id: description: The ID of the entity that performed the action. This will depend on the type of entity, as it could either be a Censys user ID or an ASM workspace ID. type: string type: description: The type of entity that performed the action. enum: - unknown - user - system - customer_support - asm_workspace type: string required: - type type: object AlternativeQuery: additionalProperties: false properties: query: description: An alternative query that may be used. type: string targets: description: The types of Platform data records (host, cert, and web) that can be targeted by the alternative query. items: enum: - host - web - cert - unknown type: string type: - array - "null" required: - query - targets type: object Amqp: additionalProperties: false properties: explicit_tls: description: Connected via a TLS connection after initial handshake type: boolean implicit_tls: description: Connected via a TLS wrapped connection (AMQPS) type: boolean protocol_id: $ref: "#/components/schemas/Amqp_Protocol" version: $ref: "#/components/schemas/Amqp_Version" type: object Amqp_Protocol: additionalProperties: false properties: id: format: int32 minimum: 0 type: integer name: type: string type: object Amqp_Version: additionalProperties: false properties: major: format: int32 minimum: 0 type: integer minor: format: int32 minimum: 0 type: integer revision: format: int32 minimum: 0 type: integer type: object AnalyticsCapabilities: additionalProperties: false properties: analytics_module_support: type: boolean cell_based_scene_description_supported: type: boolean rule_options_supported: type: boolean rule_support: type: boolean type: object AnermaCfForth: additionalProperties: false properties: ip: type: string product: type: string serial_number: type: string unit_name: type: string version: type: string type: object AnyConnect: additionalProperties: false properties: aggregate_auth_version: description: Version number indicated by the response for config-auth exchange format: int32 type: integer auth_methods: description: Supported methods for users to enter credentials for this VPN items: type: string type: - array - "null" groups: description: List of groups a user can authenticate with to use this VPN items: type: string type: - array - "null" raw: description: XML content of the config-auth response type: string response_type: description: Type of the response packet received after initializing the config-auth exchange type: string type: object AssetCertificateListInputBody: additionalProperties: false properties: certificate_ids: description: A list of SHA-256 certificate fingerprints. examples: - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf items: type: string maxItems: 1000 minItems: 1 type: - array - "null" required: - certificate_ids type: object AssetHostListInputBody: additionalProperties: false properties: at_time: description: RFC3339 Timestamp to view all requested hosts at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. examples: - "2025-01-01T00:00:00Z" format: date-time type: string host_ids: description: A list of host IP addresses. examples: - 8.8.8.8 items: type: string maxItems: 100 minItems: 1 type: - array - "null" required: - host_ids type: object AssetWebpropertyListInputBody: additionalProperties: false properties: at_time: description: RFC3339 Timestamp to view all requested webproperties at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time examples: - "2025-01-01T00:00:00Z" format: date-time type: string webproperty_ids: description: A list of web property identifiers. examples: - platform.censys.io:80 items: type: string maxItems: 100 minItems: 1 type: - array - "null" required: - webproperty_ids type: object AsteriskManagerInterface: additionalProperties: false properties: version: type: string type: object Attribute: additionalProperties: false properties: components: items: $ref: "#/components/schemas/CPE" type: - array - "null" confidence: format: double type: number cpe: type: string edition: type: string evidence: items: $ref: "#/components/schemas/Evidence" type: - array - "null" life_cycle: $ref: "#/components/schemas/CPE_LifeCycle" part: type: string product: type: string source: enum: - "" - censys - recog - wappalyzer - third_party - html_meta_extractor type: string type: items: type: string type: - array - "null" update: type: string vendor: type: string version: type: string type: object AuditLogEvent: additionalProperties: false properties: actor: $ref: "#/components/schemas/ActorInfo" description: Information about the entity that performed the action. authentication_method: description: The method used by the actor to authenticate before performing the action. type: string event_type: description: The type of action that was audited. enum: - user_created - user_login - user_login_failed - user_password_changed - user_password_reset - user_mfa_changed - user_settings_changed - user_enabled - user_disabled - invitation_created - invitation_resent - invitation_accepted - invitation_deleted - membership_created - membership_updated - membership_removed - org_created - org_updated - org_deleted - saml_config_created - saml_config_updated - saml_config_deleted - saml_config_domain_verified - pat_created - pat_deleted - global_data_search_executed - global_data_lookup_executed - global_data_aggregation_executed - asm_seed_created - asm_seed_deleted - asm_exclude_created - asm_exclude_deleted - asm_risk_instance_severity_changed - asm_risk_instance_accepted - asm_risk_instance_unaccepted - asm_risk_type_severity_changed - asm_risk_type_enabled - asm_risk_type_disabled - asm_risk_type_default_enabled - tag_created - tag_updated - tag_deleted - tag_assigned - tag_unassigned - tag_bulk_operation_started - tag_bulk_operation_completed - tag_bulk_operation_cancelled - comment_created - comment_updated - comment_deleted type: string metadata: additionalProperties: {} description: Event-specific metadata. Contents vary by event type. type: object source: description: Where the audited action originated from. type: string source_ip: description: The IP address of the source of the audited action. type: string subject: $ref: "#/components/schemas/SubjectInfo" description: Information about the resource that was affected by the audited action. timestamp: description: The timestamp of the audit log event. format: date-time type: string user_agent: description: The user agent of the source of the audited action. type: string required: - timestamp - event_type - actor - subject type: object AuditLogEventsResponse: additionalProperties: false properties: events: description: The page of audit log events for the requested filters and pagination parameters. items: $ref: "#/components/schemas/AuditLogEvent" type: - array - "null" pagination: $ref: "#/components/schemas/PaginationInfo" description: Pagination information for listing more events. total_results: format: int64 type: integer required: - events - pagination - total_results type: object Auth: additionalProperties: false properties: enabled: type: boolean type: object AuthenticationError: additionalProperties: false properties: error: $ref: "#/components/schemas/AuthenticationErrorDetail" description: Detailed information about the authentication error type: object AuthenticationErrorDetail: additionalProperties: false properties: code: description: HTTP status code examples: - 401 format: int64 type: integer message: description: Human-readable message describing the error occurrence examples: - Access credentials are invalid type: string reason: description: Human-readable explanation of the underlying cause of the error examples: - Access token is not active type: string request: type: string status: description: HTTP status message associated with the error examples: - Unauthorized type: string type: object AuthorityInfoAccess: additionalProperties: false properties: issuer_urls: items: type: string type: - array - "null" ocsp_urls: items: type: string type: - array - "null" type: object AutoReplenishConfig: additionalProperties: false properties: amount: description: The amount of credits to replenish when auto-replenish is triggered. format: int64 type: integer enabled: description: Whether the organization has auto-replenish enabled. type: boolean threshold: description: The threshold at which the organization's credit balance will be auto-replenished. format: int64 type: integer required: - enabled type: object AutonomousSystem: additionalProperties: false properties: asn: description: The ASN (autonomous system number) of the host's autonomous system. format: int32 minimum: 0 type: integer bgp_prefix: description: The autonomous system's CIDR. type: string country_code: description: The autonomous system's two-letter ISO 3166-1 alpha-2 country code (US, CN, GB, RU, ...). type: string description: description: Brief description of the autonomous system. type: string name: description: The friendly name of the autonomous system. type: string organization: description: The name of the organization managning the autonomous system. type: string type: object Bacnet: additionalProperties: false properties: application_software_revision: type: string description: type: string firmware_revision: type: string instance_number: format: int32 minimum: 0 type: integer location: type: string model_name: type: string object_name: type: string vendor_id: format: int32 minimum: 0 type: integer vendor_name: type: string type: object BasicConstraints: additionalProperties: false properties: is_ca: description: Whether the certificate is permitted to sign other certificates. type: boolean max_path_len: description: When present, provides the maximum number of intermediate certificates that may follow this certificate in a trusted certification path. format: int32 type: integer type: object CPE: additionalProperties: false properties: cpe: type: string edition: type: string life_cycle: $ref: "#/components/schemas/CPE_LifeCycle" part: type: string product: type: string update: type: string vendor: type: string version: type: string type: object CPE_LifeCycle: additionalProperties: false properties: end_of_life: type: boolean end_of_life_date: type: string release_date: type: string type: object CVSS: additionalProperties: false properties: components: $ref: "#/components/schemas/CVSS_Components" description: These metrics contribute to how a CVE is scored. score: description: Score of the vulnerability; 0.1 is the lowest, 10 is the maximum format: double type: number vector: description: The path, method, or scenario used to exploit the vulnerability. Each section represents components that contribute to the overall CVSS score. type: string type: object CVSS_Components: additionalProperties: false properties: attack_complexity: description: "Indicates conditions beyond the attacker’s control that must exist in order to exploit the vulnerability. The Attack Complexity metric is scored as either Low or High. There are two possible values: Low (L) – There are no specific pre-conditions required for exploitation, High (H) – The attacker must complete some number of preparatory steps in order to get access." enum: - "" - low - high type: string attack_vector: description: "Indicates the level of access required for an attacker to exploit the vulnerability. The Attack Vector metric is scored in one of four levels: Network (N) – Vulnerabilities with this rating are remotely exploitable, from one or more hops away, up to, and including, remote exploitation over the Internet, Adjacent (A) – A vulnerability with this rating requires network adjacency for exploitation. The attack must be launched from the same physical or logical network, Local (L) – Vulnerabilities with this rating are not exploitable over a network, Physical (P) – An attacker must physically interact with the target system." enum: - "" - network - adjacent - local - physical type: string availability: description: "If an attack renders information unavailable, such as when a system crashes or through a DDoS attack, availability is negatively impacted. Availability has three possible values: None (N) – There is no loss of availability, Low (L) – Availability might be intermittently limited, or performance might be negatively impacted, as a result of a successful attack, High (H) – There is a complete loss of availability of the impacted system or information." enum: - "" - none - low - high type: string confidentiality: description: "Refers to the disclosure of sensitive information to authorized and unauthorized users, with the goal being that only authorized users are able to access the target data. Confidentiality has three potential values: High (H) – The attacker has full access to all resources in the impacted system, including highly sensitive information such as encryption keys, Low (L) – The attacker has partial access to information, with no control over what, specifically, they are able to access, None (N) – No data is accessible to unauthorized users as a result of the exploit." enum: - "" - none - low - high type: string integrity: description: "Refers to whether the protected information has been tampered with or changed in any way. If there is no way for an attacker to alter the accuracy or completeness of the information, integrity has been maintained. Integrity has three values: None (N) – There is no loss of the integrity of any information, Low (L) – A limited amount of information might be tampered with or modified, but there is no serious impact on the protected system, High (H) – The attacker can modify any/all information on the target system, resulting in a complete loss of integrity." enum: - "" - none - low - high type: string privileges_required: description: "Describes the level of privileges or access an attacker must have before successful exploitation. There are three possible values: None (N) – There is no privilege or special access required to conduct the attack, Low (L) – The attacker requires basic, “user” level privileges to leverage the exploit, High (H) – Administrative or similar access privileges are required for successful attack." enum: - "" - none - low - high type: string scope: description: "Determines whether a vulnerability in one system or component can impact another system or component. If a vulnerability in a vulnerable component can affect a component which is in a different security scope than the vulnerable component, a scope change occurs. Scope has two possible ratings: Changed (C) – An exploited vulnerability can have a carry over impact on another system, Unchanged (U) – The exploited vulnerability is limited in damage to only the local security authority." enum: - "" - unchanged - changed type: string user_interaction: description: "Describes whether a user, other than the attacker, is required to do anything or participate in exploitation of the vulnerability. User interaction has two possible values: None (N) – No user interaction is required, Required (R) – A user must complete some steps for the exploit to succeed. For example, a user might be required to install some software." enum: - "" - none - required type: string type: object CVSSv4: additionalProperties: false properties: components: $ref: "#/components/schemas/CVSSv4_Components" description: These metrics contribute to how a CVE is scored. score: description: Score of the vulnerability; 0.1 is the lowest, 10 is the maximum format: double type: number vector: description: The path, method, or scenario used to exploit the vulnerability. Each section represents components that contribute to the overall CVSS score. type: string type: object CVSSv4_Components: additionalProperties: false properties: attack_complexity: description: "Indicates conditions beyond the attacker’s control that must exist in order to exploit the vulnerability. The Attack Complexity metric is scored as either Low or High. There are two possible values: Low (L) – There are no specific pre-conditions required for exploitation, High (H) – The attacker must complete some number of preparatory steps in order to get access." enum: - "" - low - high type: string attack_requirements: enum: - "" - none - present type: string attack_vector: description: "Indicates the level of access required for an attacker to exploit the vulnerability. The Attack Vector metric is scored in one of four levels: Network (N) – Vulnerabilities with this rating are remotely exploitable, from one or more hops away, up to, and including, remote exploitation over the Internet, Adjacent (A) – A vulnerability with this rating requires network adjacency for exploitation. The attack must be launched from the same physical or logical network, Local (L) – Vulnerabilities with this rating are not exploitable over a network, Physical (P) – An attacker must physically interact with the target system." enum: - "" - network - adjacent - local - physical type: string automatable: enum: - "" - "no" - "yes" type: string availability: description: "If an attack renders information unavailable, such as when a system crashes or through a DDoS attack, availability is negatively impacted. Availability has three possible values: None (N) – There is no loss of availability, Low (L) – Availability might be intermittently limited, or performance might be negatively impacted, as a result of a successful attack, High (H) – There is a complete loss of availability of the impacted system or information." enum: - "" - none - low - high type: string confidentiality: description: "Refers to the disclosure of sensitive information to authorized and unauthorized users, with the goal being that only authorized users are able to access the target data. Confidentiality has three potential values: High (H) – The attacker has full access to all resources in the impacted system, including highly sensitive information such as encryption keys, Low (L) – The attacker has partial access to information, with no control over what, specifically, they are able to access, None (N) – No data is accessible to unauthorized users as a result of the exploit." enum: - "" - none - low - high type: string integrity: description: "Refers to whether the protected information has been tampered with or changed in any way. If there is no way for an attacker to alter the accuracy or completeness of the information, integrity has been maintained. Integrity has three values: None (N) – There is no loss of the integrity of any information, Low (L) – A limited amount of information might be tampered with or modified, but there is no serious impact on the protected system, High (H) – The attacker can modify any/all information on the target system, resulting in a complete loss of integrity." enum: - "" - none - low - high type: string privileges_required: description: "Describes the level of privileges or access an attacker must have before successful exploitation. There are three possible values: None (N) – There is no privilege or special access required to conduct the attack, Low (L) – The attacker requires basic, “user” level privileges to leverage the exploit, High (H) – Administrative or similar access privileges are required for successful attack." enum: - "" - none - low - high type: string provider_urgency: enum: - "" - clear - green - amber - red type: string recovery: enum: - "" - automatic - user - irrecoverable type: string safety: enum: - "" - negligible - present type: string user_interaction: description: "Describes whether a user, other than the attacker, is required to do anything or participate in exploitation of the vulnerability. User interaction has two possible values: None (N) – No user interaction is required, Required (R) – A user must complete some steps for the exploit to succeed. For example, a user might be required to install some software." enum: - "" - none - required type: string value_density: enum: - "" - diffuse - concentrated type: string vulnerability_response_effort: enum: - "" - low - moderate - high type: string type: object CWE: additionalProperties: false properties: entry: description: A unique identifier associated with a class of a software or hardware weakness. type: string type: object CabfOrganizationId: additionalProperties: false properties: country: type: string reference: type: string scheme: type: string state: type: string type: object Capabilities: additionalProperties: false properties: analytics: $ref: "#/components/schemas/AnalyticsCapabilities" device: $ref: "#/components/schemas/DeviceCapabilities" device_io: $ref: "#/components/schemas/DeviceIOCapabilities" events: $ref: "#/components/schemas/EventsCapabilities" image: $ref: "#/components/schemas/ImageCapabilities" media: $ref: "#/components/schemas/MediaCapabilities" pan_tilt_zoom: $ref: "#/components/schemas/PanTiltZoomCapabilities" recording: $ref: "#/components/schemas/RecordingCapabilities" replay: $ref: "#/components/schemas/ReplayCapabilities" search: $ref: "#/components/schemas/SearchCapabilities" type: object CenseyeJob: additionalProperties: false properties: at_time: description: The point-in-time the asset data was evaluated at. format: date-time type: string create_time: description: When the job was created. format: date-time type: string delete_time: description: When the job and results will be deleted. format: date-time type: string error: description: Error message if the job failed. type: string job_id: description: Unique identifier of the job. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string result_count: description: Total number of result field-value pairs. examples: - 42 format: int32 minimum: 0 type: integer state: description: Current state of the job. enum: - started - completed - failed - unknown examples: - completed type: string target: $ref: "#/components/schemas/CenseyeTarget" description: The asset that was analyzed. update_time: description: When the job was last updated. format: date-time type: string required: - job_id - target - state type: object CenseyeJobsListResponse: additionalProperties: false properties: jobs: description: List of CensEye jobs. items: $ref: "#/components/schemas/CenseyeJob" type: - array - "null" next_page_token: description: Token to retrieve the next page of jobs. type: string required: - jobs type: object CenseyeResult: additionalProperties: false properties: count: description: Number of matching documents for this field-value combination. format: double type: number field_value_pairs: description: The field-value pairs that were counted. items: $ref: "#/components/schemas/FieldValuePair" type: - array - "null" required: - count - field_value_pairs type: object CenseyeResultsResponse: additionalProperties: false properties: next_page_token: description: Token to retrieve the next page of results. type: string results: description: List of count results. items: $ref: "#/components/schemas/CenseyeResult" type: - array - "null" required: - results type: object CenseyeTarget: additionalProperties: false properties: certificate_id: description: SHA-256 fingerprint of the certificate to analyze. examples: - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf type: string host_id: description: IP address of the host to analyze. examples: - 8.8.8.8 type: string webproperty_id: description: Web property identifier (hostname:port) to analyze. examples: - example.com:443 type: string type: object Certificate: additionalProperties: false properties: added_at: description: When the certificate was added to the Censys dataset. type: string ct: $ref: "#/components/schemas/Ct" ever_seen_in_scan: description: Whether the certificate has ever been presented by a service during a scan. type: boolean fingerprint_md5: description: The MD-5 digest of the entire raw certificate. An identifier used by some systems. format: hex type: string fingerprint_sha1: description: The SHA-1 digest of the entire raw certificate. An identifier used by some systems. format: hex type: string fingerprint_sha256: description: The SHA-256 digest of the entire raw certificate. Its unique identifier, which Censys uses to index certificates records. format: hex type: string modified_at: description: When the certificate record was last modified. type: string names: description: All the names contained in the certificate from various fields. items: type: string type: - array - "null" parent_spki_fingerprint_sha256: description: "DEPRECATED: Use parent_spki_subject_fingerprint_sha256" format: hex type: string parent_spki_subject_fingerprint_sha256: description: The SHA-256 digest of the parent certificate's DER-encoded SubjectPublicKeyInfo concatenated with its Subject. format: hex type: string parse_status: enum: - "" - success - fail - corrupted type: string parsed: $ref: "#/components/schemas/Certificate_Parsed" description: A record containing all of the data parsed from the certificate. precert: description: "Whether the X.509 \"poison\" extension (OID: 1.3.6.1.4.1.11129.2.4.3) is marked critical, which prohibits the pre-certificate from being trusted." type: boolean revocation: $ref: "#/components/schemas/CertificateRevocation" description: A record containing revocation information, if the certificate has been revoked. revoked: description: Whether the certificate has been revoked before its expiry date by the issuer. type: boolean spki_fingerprint_sha256: description: "DEPRECATED: Use spki_subject_fingerprint_sha256" format: hex type: string spki_subject_fingerprint_sha256: description: The SHA-256 digest of the certificate's DER-encoded SubjectPublicKeyInfo concatenated with its Subject. format: hex type: string tbs_fingerprint_sha256: description: The SHA-256 digest of the unsigned certificate's contents. format: hex type: string tbs_no_ct_fingerprint_sha256: description: The SHA-256 digest of the unsigned certificate with the CT Poison extension removed, if present. This represents the shared contents of a certificate and its corresponding pre-certificate. format: hex type: string validated_at: description: When the certificate record's trust was last checked. type: string validation: $ref: "#/components/schemas/Validation" description: A record containing information from the maintainers of major root certificate stores related to their trust assessment. validation_level: description: The extent to which the certificate's issuer validated the identity of the entity requesting the certificate. Options include Domain validated (DV), Organization Validated (OV), or Extended Validation (EV). enum: - "" - dv - ov - ev type: string zlint: $ref: "#/components/schemas/ZLint" description: A record containing the results of linting the certificate for conformance to the X.509 standard using Zlint. type: object CertificateAsset: additionalProperties: false properties: extensions: additionalProperties: {} type: object resource: $ref: "#/components/schemas/Certificate" required: - resource - extensions type: object CertificateExtensions: additionalProperties: false properties: authority_info_access: $ref: "#/components/schemas/AuthorityInfoAccess" description: "The parsed id-pe-authorityInfoAccess extension (OID: 1.3.6.1.5.7.1.1). Only id-ad-caIssuers and id-ad-ocsp accessMethods are supported; others are omitted." authority_key_id: description: A key identifier, usually a digest of the DER-encoded SubjectPublicKeyInfo. format: hex type: string basic_constraints: $ref: "#/components/schemas/BasicConstraints" description: "The parsed id-ce-basicConstraints extension (OID: 2.5.29.19)." cabf_organization_id: $ref: "#/components/schemas/CabfOrganizationId" description: "CA/Browser Forum organization ID extensions (OID: 2.23.140.3.1)." certificate_policies: description: "The parsed id-ce-certificatePolicies extension (OID: 2.5.29.32)." items: $ref: "#/components/schemas/CertificatePolicy" type: - array - "null" crl_distribution_points: description: "The parsed id-ce-cRLDistributionPoints extension (OID: 2.5.29.31). Contents are a list of distributionPoint URLs; other distributionPoint types are omitted)." items: type: string type: - array - "null" ct_poison: description: "Whether the certificate possesses the pre-certificate \"poison\" extension (OID: 1.3.6.1.4.1.11129.2.4.3)." type: boolean extended_key_usage: $ref: "#/components/schemas/ExtendedKeyUsage" description: "The parsed id-ce-extKeyUsage extension (OID: 2.5.29.37)." issuer_alt_name: $ref: "#/components/schemas/GeneralNames" description: "The parsed id-ce-issuerAltName extension (OID: 2.5.29.18)." key_usage: $ref: "#/components/schemas/KeyUsage" description: "The parsed id-ce-keyUsage extension (OID: 2.5.29.15)." name_constraints: $ref: "#/components/schemas/NameConstraints" description: "The parsed id-ce-nameConstraints extension (OID: 2.5.29.30). Specifies a name space within which all child certificates' subject names MUST be located." qc_statements: $ref: "#/components/schemas/QcStatements" signed_certificate_timestamps: items: $ref: "#/components/schemas/SignedCertificateTimestamp" type: - array - "null" subject_alt_name: $ref: "#/components/schemas/GeneralNames" description: "The parsed id-ce-subjectAltName extension (OID: 2.5.29.17)." subject_key_id: description: A key identifier, usually a digest of the DER-encoded SubjectPublicKeyInfo.. format: hex type: string tor_service_descriptors: items: $ref: "#/components/schemas/TorServiceDescriptor" type: - array - "null" type: object CertificatePolicy: additionalProperties: false properties: cps: items: type: string type: - array - "null" id: type: string user_notice: items: $ref: "#/components/schemas/UserNotice" type: - array - "null" type: object CertificateRevocation: additionalProperties: false properties: crl: $ref: "#/components/schemas/CertificateRevocation_RevocationInfo" ocsp: $ref: "#/components/schemas/CertificateRevocation_RevocationInfo" type: object CertificateRevocation_RevocationInfo: additionalProperties: false properties: next_update: type: string reason: description: An enumerated value indicating the issuer-supplied reason for the revocation. enum: - "" - unspecified - key_compromise - ca_compromise - affiliation_changed - superseded - cessation_of_operation - certificate_hold - remove_from_crl - privilege_withdrawn - aa_compromise type: string revocation_time: description: The issuer-supplied timestamp indicating when the certificate was revoked. type: string revoked: description: Whether the certificate has been revoked before its expiry date by the issuer. type: boolean type: object Certificate_Parsed: additionalProperties: false properties: extensions: $ref: "#/components/schemas/CertificateExtensions" description: A record containing parsed X.509 extensions that provide additional identification information or additional cryptographic capabilities. issuer: $ref: "#/components/schemas/DistinguishedName" description: A record containing the parsed contents of the issuer_dn. issuer_dn: description: Distinguished Name of the entity that has signed and issued the certificate. type: string ja4x: type: string redacted: type: boolean serial_number: description: Issuer-specific identifier of the certificate. type: string serial_number_hex: description: Issuer-specific identifier of the certificate, represented as hexadecimal. type: string signature: $ref: "#/components/schemas/Signature" subject: $ref: "#/components/schemas/DistinguishedName" description: A record containing the parsed contents of the subject_dn. subject_dn: description: Distinguished Name of the entity associated with the public key. type: string subject_key_info: $ref: "#/components/schemas/SubjectKeyInfo" description: Information about the certificate's public key. unknown_extensions: items: $ref: "#/components/schemas/Extension" type: - array - "null" validity_period: $ref: "#/components/schemas/ValidityPeriod" description: Information about the time for which the certificate is valid. version: format: int32 type: integer type: object CheckpointTopology: additionalProperties: false properties: common_name: type: string organization: type: string type: object ChromeDevtools: additionalProperties: false properties: browser: type: string protocol_version: type: string targets: items: $ref: "#/components/schemas/ChromeDevtools_Target" type: - array - "null" user_agent: type: string v8_version: type: string webkit_version: type: string type: object ChromeDevtools_Target: additionalProperties: false properties: title: type: string type: type: string url: type: string type: object Chromecast: additionalProperties: false properties: applications: items: $ref: "#/components/schemas/Chromecast_Application" type: - array - "null" icon_url: format: utf8 type: string is_active_input: type: boolean protocol_version: format: int32 type: integer status_text: format: utf8 type: string universal_app_id: format: utf8 type: string volume: $ref: "#/components/schemas/Chromecast_Volume" type: object Chromecast_Application: additionalProperties: false properties: app_id: format: utf8 type: string app_type: format: utf8 type: string display_name: format: utf8 type: string namespaces: items: $ref: "#/components/schemas/Chromecast_Namespace" type: - array - "null" session_id: format: utf8 type: string transport_id: format: utf8 type: string type: object Chromecast_Namespace: additionalProperties: false properties: name: format: utf8 type: string type: object Chromecast_Volume: additionalProperties: false properties: control_type: format: utf8 type: string level: format: float type: number muted: type: boolean step_interval: $ref: "#/components/schemas/FloatValue" type: object CiscoIpsla: additionalProperties: false properties: handshake: $ref: "#/components/schemas/CiscoIpsla_Handshake" measure_response: $ref: "#/components/schemas/CiscoIpsla_MeasureResponse" type: object CiscoIpsla_Handshake: additionalProperties: false properties: header: $ref: "#/components/schemas/CiscoIpsla_Handshake_Header" message: $ref: "#/components/schemas/CiscoIpsla_Handshake_Message" type: object CiscoIpsla_Handshake_Header: additionalProperties: false properties: length: format: int32 minimum: 0 type: integer seq: format: int32 minimum: 0 type: integer unknown: format: int32 minimum: 0 type: integer version: format: int32 minimum: 0 type: integer type: object CiscoIpsla_Handshake_Message: additionalProperties: false properties: ip: type: string length: format: int32 minimum: 0 type: integer port: format: int32 minimum: 0 type: integer type: format: int32 minimum: 0 type: integer type: object CiscoIpsla_MeasureResponse: additionalProperties: false properties: flags: format: int32 minimum: 0 type: integer payload: format: base64 type: string receive_seq: format: int32 minimum: 0 type: integer receive_time: format: int64 minimum: 0 type: integer send_seq: format: int32 minimum: 0 type: integer send_time: format: int64 minimum: 0 type: integer type: format: int32 minimum: 0 type: integer type: object Cmore: additionalProperties: false type: object Coap: additionalProperties: false properties: code: type: string message_id: format: int32 minimum: 0 type: integer message_type: type: string payload: format: hex type: string token: format: hex type: string version: format: int32 minimum: 0 type: integer type: object CobaltStrike: additionalProperties: false properties: x64: $ref: "#/components/schemas/CobaltStrike_Config" x86: $ref: "#/components/schemas/CobaltStrike_Config" type: object CobaltStrike_Config: additionalProperties: false properties: cookie_beacon: format: int32 minimum: 0 type: integer crypto_scheme: format: int32 minimum: 0 type: integer dns: type: boolean host_header: format: utf8 type: string http_get: $ref: "#/components/schemas/CobaltStrike_HttpConfig" http_post: $ref: "#/components/schemas/CobaltStrike_HttpConfig" jitter: format: int32 minimum: 0 type: integer killdate: format: int32 minimum: 0 type: integer post_ex: $ref: "#/components/schemas/CobaltStrike_PostEx" public_key: format: hex type: string sleep_time: format: int32 minimum: 0 type: integer ssl: type: boolean unknown_bytes: additionalProperties: type: - string - "null" format: base64 type: object unknown_int: additionalProperties: format: int32 minimum: 0 type: integer type: object user_agent: format: utf8 type: string watermark: format: int32 minimum: 0 type: integer type: object CobaltStrike_HttpConfig: additionalProperties: false properties: client: format: utf8 type: string uri: format: utf8 type: string verb: format: utf8 type: string type: object CobaltStrike_PostEx: additionalProperties: false properties: x64: format: utf8 type: string x86: format: utf8 type: string type: object Collection: additionalProperties: false properties: added_assets_24_hours: format: int64 type: integer create_time: format: date-time type: string created_by: description: The ID of a Censys user who created the collection. format: uuid type: string description: type: string id: type: string name: type: string query: type: string removed_assets_24_hours: format: int64 type: integer status: enum: - unspecified - populating - active - paused - archived type: string status_reason: enum: - unspecified - not_enough_credits - not_entitled - too_many_assets - manual - query_changed - initial type: - string - "null" total_assets: format: int64 type: integer required: - id - name - description - query - total_assets - create_time - status - status_reason - added_assets_24_hours - removed_assets_24_hours type: object CollectionEvent: additionalProperties: false properties: asset_change: $ref: "#/components/schemas/EventAssetChange" status_change: $ref: "#/components/schemas/EventStatusChange" type: object CollectionEventsResponse: additionalProperties: false properties: events: items: $ref: "#/components/schemas/CollectionEvent" type: - array - "null" next_page: type: string required: - events - next_page type: object Comment: additionalProperties: false properties: asset_id: description: The identifier of the commented asset (host IP, certificate SHA-256 fingerprint, or web property domain/IP:port). type: string asset_type: description: The inferred type of the asset. enum: - host - certificate - web_property - unknown type: string body: description: The comment body text. type: string created_at: description: RFC3339 timestamp when the comment was created. format: date-time type: string created_by: description: The user ID of the user who created the comment. format: uuid type: string id: description: The unique ID of the comment. format: uuid type: string platform_ref: description: A direct URL to the asset in the Censys platform. type: string updated_at: description: RFC3339 timestamp when the comment was last updated. format: date-time type: string required: - id - asset_id - asset_type - platform_ref - body - created_at - updated_at - created_by type: object CommentsList: additionalProperties: false properties: comments: description: The list of comments. items: $ref: "#/components/schemas/Comment" type: - array - "null" next_page_token: description: Token to retrieve the next page of results. Omitted when there are no more results. type: string total_size: description: Total number of comments matching the filters. format: int64 type: integer required: - comments - total_size type: object Connection: additionalProperties: false properties: ahs_length: format: int32 minimum: 0 type: integer cmd_seq: format: int32 minimum: 0 type: integer isid: format: int64 minimum: 0 type: integer keyval_pairs: items: type: string type: - array - "null" max_new_cmds: format: int32 minimum: 0 type: integer status_seq: format: int32 minimum: 0 type: integer tsih: format: int64 minimum: 0 type: integer version_active: format: int32 minimum: 0 type: integer version_max: format: int32 minimum: 0 type: integer type: object Contact: additionalProperties: false properties: email: type: string handle: type: string name: type: string type: object ConvertQueryError: additionalProperties: false properties: message: description: The error message if the query could not be converted. type: string required: - message type: object Coordinates: additionalProperties: false properties: latitude: format: double type: number longitude: format: double type: number type: object CountCondition: additionalProperties: false properties: field_value_pairs: description: Field-value pairs to count matches for. Must target fields from the same nested object and may contain at most 5 pairs per group. items: $ref: "#/components/schemas/FieldValuePair" type: - array - "null" required: - field_value_pairs type: object CreateCenseyeJobInputBody: additionalProperties: false properties: target: $ref: "#/components/schemas/CenseyeTarget" description: The asset to analyze. Exactly one of host_id, webproperty_id, or certificate_id must be set. required: - target type: object CreateCommentInputBody: additionalProperties: false properties: asset_id: description: The identifier of the asset (host IP, certificate SHA-256 fingerprint, or web property hostname:port). examples: - 8.8.8.8 - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf - platform.censys.io:443 type: string body: description: The comment body text. maxLength: 10000 minLength: 1 type: string required: - asset_id - body type: object CreateTagAssignmentInputBody: additionalProperties: false properties: asset_id: description: The identifier of the asset (host IP, certificate SHA-256 fingerprint, or web property hostname:port). examples: - 8.8.8.8 - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf - platform.censys.io:443 type: string required: - asset_id type: object CreateTagInputBody: additionalProperties: false properties: description: description: A human-readable description of the tag. maxLength: 1000 type: string name: description: The display name of the tag. Must be unique within the organization. maxLength: 255 minLength: 1 type: string privacy: description: Tag visibility and management settings. `private` tags are only visible to and editable by organization admins. `shared` tags are visible to and editable by all organization members. enum: - private - shared type: string required: - name - privacy type: object CreditExpiration: additionalProperties: false properties: balance: description: The current balance of the credit expiration. format: int64 type: integer created_at: description: The date and time the credit expiration was created. format: date-time type: string expires_at: description: The date and time the credit expiration will expire. format: date-time type: string initial_balance: description: The initial balance of the credit expiration (i.e. how much was purchased). format: int64 type: integer required: - balance - initial_balance type: object CreditUsageReport: additionalProperties: false properties: credits_consumed_by_consumer: description: The breakdown of credits consumed by consumer. This may not be present if the report is generated for a specific user. type: string credits_consumed_by_source: $ref: "#/components/schemas/SourceUsageBreakdown" description: The breakdown of credits consumed by source. end_time: description: The end time of the window for this report. format: date-time type: string granularity: default: daily description: The granularity of the report. enum: - daily - monthly examples: - daily type: string periods: description: The periods of the report (i.e. time buckets). items: $ref: "#/components/schemas/CreditUsageReportPeriod" type: - array - "null" start_time: description: The start time of the window for this report. format: date-time type: string total_added: description: The total amount of credits added during the report period. format: int64 type: integer total_consumed: description: The total amount of credits consumed during the report period. format: int64 type: integer total_expired: description: The total amount of credits expired during the report period. format: int64 type: integer transaction_count: description: The total number of transactions during the report period. format: int64 type: integer required: - start_time - end_time - granularity - total_consumed - total_added - total_expired - transaction_count - periods - credits_consumed_by_source type: object CreditUsageReportPeriod: additionalProperties: false properties: credits_added: description: The total amount of credits added during the report period. format: int64 type: integer credits_consumed: description: The total amount of credits consumed during the report period. format: int64 type: integer credits_expired: description: The total amount of credits expired during the report period. format: int64 type: integer end_date: description: The end date of the window for this report period. format: date-time type: string start_date: description: The start date of the window for this report period. format: date-time type: string transaction_count: description: The total number of transactions during the report period. format: int64 type: integer required: - start_date - end_date - credits_consumed - credits_added - credits_expired - transaction_count type: object CrestronCp3: additionalProperties: false properties: version_string: type: string type: object CrestronDinAp2: additionalProperties: false properties: version_string: type: string type: object CrudCreateInputBody: additionalProperties: false properties: description: description: description of the collection examples: - Hosts with services with AsyncRAT indicator in cert subject DN type: string name: description: name of the collection examples: - Hosts services with AsyncRAT indicator type: string query: description: query string to search upon to build the collection examples: - "host.services.cert.parsed.subject_dn: \"asyncrat\"" type: string required: - name - query type: object CrudUpdateInputBody: additionalProperties: false properties: description: description: description of the collection examples: - Hosts with services with AsyncRAT indicator in cert subject DN type: string name: description: name of the collection examples: - Hosts services with AsyncRAT indicator type: string query: description: query string to search upon to build the collection examples: - "host.services.cert.parsed.subject_dn: \"asyncrat\"" type: string required: - name - query type: object CryptSetup: additionalProperties: false properties: client_nonce: format: base64 type: string key: format: base64 type: string server_nonce: format: base64 type: string type: object Ct: additionalProperties: false properties: entries: additionalProperties: $ref: "#/components/schemas/Ct_Record" type: object type: object Ct_Record: additionalProperties: false properties: added_to_ct_at: description: An RFC-3339-formatted timestamp indicating when the certificate was entered into the CT log. type: string ct_to_censys_at: description: An RFC-3339-formated timestamp indicating when the certificate was ingested from the CT log into the Censys dataset. type: string index: description: Numerical marker of the certificate's place in the CT log. format: int64 type: integer type: object CursorOnTarget: additionalProperties: false properties: events: items: $ref: "#/components/schemas/CursorOnTarget_Event" type: - array - "null" type: object CursorOnTarget_Event: additionalProperties: false properties: callsign: type: string endpoint: type: string how: type: string point: $ref: "#/components/schemas/CursorOnTarget_Point" stale: type: string start: type: string status: $ref: "#/components/schemas/CursorOnTarget_Status" takv: $ref: "#/components/schemas/CursorOnTarget_Takv" time: type: string type: type: string uid: type: string version: type: string video_url: type: string type: object CursorOnTarget_Point: additionalProperties: false properties: ce: format: double type: number hae: format: double type: number lat: format: double type: number le: format: double type: number lon: format: double type: number type: object CursorOnTarget_Status: additionalProperties: false properties: battery: type: string type: object CursorOnTarget_Takv: additionalProperties: false properties: device: type: string os: type: string platform: type: string version: type: string type: object Cwmp: additionalProperties: false properties: auth: items: type: string type: - array - "null" cookies: items: type: string type: - array - "null" server: type: string type: object DSACryptographicKey: additionalProperties: false properties: g: format: base64 type: string p: format: base64 type: string q: format: base64 type: string "y": format: base64 type: string type: object Darkcomet: additionalProperties: false properties: version: type: string type: object Darkgate: additionalProperties: false properties: files: items: $ref: "#/components/schemas/Darkgate_File" type: - array - "null" type: object Darkgate_File: additionalProperties: false properties: length: format: int32 type: integer name: type: string type: object Dcerpc: additionalProperties: false properties: could_bind: type: boolean could_query_epm: type: boolean endpoints: items: $ref: "#/components/schemas/Dcerpc_Endpoint" type: - array - "null" type: object Dcerpc_Endpoint: additionalProperties: false properties: bindings: items: type: string type: - array - "null" executable: type: string explained_uuid: type: string protocol: type: string type: object DesktopInfo: additionalProperties: false properties: height: format: int32 minimum: 0 type: integer name_len: format: int32 minimum: 0 type: integer pixel_format: $ref: "#/components/schemas/PixelFormat" width: format: int32 minimum: 0 type: integer type: object DeviceCapabilities: additionalProperties: false properties: network: $ref: "#/components/schemas/NetworkCapabilities" security: $ref: "#/components/schemas/SecurityCapabilities" system: $ref: "#/components/schemas/SystemCapabilities" type: object DeviceIOCapabilities: additionalProperties: false properties: audio_outputs: format: int32 minimum: 0 type: integer audio_sources: format: int32 minimum: 0 type: integer digital_inputs: format: int32 minimum: 0 type: integer relay_outputs: format: int32 minimum: 0 type: integer serial_ports: format: int32 minimum: 0 type: integer video_outputs: format: int32 minimum: 0 type: integer video_source: format: int32 minimum: 0 type: integer type: object Dhcpdiscover: additionalProperties: false properties: method: type: string params: $ref: "#/components/schemas/Dhcpdiscover_ResponseParams" type: object Dhcpdiscover_DeviceInfo: additionalProperties: false properties: alarm_input_channels: format: int64 type: integer alarm_output_channels: format: int64 type: integer device_class: type: string device_id: type: string device_type: type: string http_port: format: int64 type: integer ipv4_address: $ref: "#/components/schemas/Dhcpdiscover_IpAddress" ipv6_address: $ref: "#/components/schemas/Dhcpdiscover_IpAddress" machine_group: type: string machine_name: type: string manufacturer: type: string port: format: int64 type: integer remote_video_input_channels: format: int64 type: integer serial_number: type: string unlogin_func_mask: format: int64 type: integer vendor: type: string version: type: string video_input_channels: format: int64 type: integer video_output_channels: format: int64 type: integer type: object Dhcpdiscover_IpAddress: additionalProperties: false properties: default_gateway: type: string dhcp_enable: type: boolean ip_address: type: string link_local_address: type: string subnetmask: type: string type: object Dhcpdiscover_ResponseParams: additionalProperties: false properties: device_info: $ref: "#/components/schemas/Dhcpdiscover_DeviceInfo" type: object DistinguishedName: additionalProperties: false properties: common_name: description: "The commonName (CN) elements of the Distinguished Name (OID: 2.5.4.3)." items: type: string type: - array - "null" country: description: "The countryName (C) elements of the Distinguished Name (OID: 2.5.4.6)." items: type: string type: - array - "null" domain_component: description: "The domainComponent (DC) elements of the Distinguished Name (OID: 0.9.2342.19200300.100.1.25)." items: type: string type: - array - "null" email_address: description: "The emailAddress (E) elements of the Distinguished Name (OID: 1.2.840.113549.1.9.1)." items: type: string type: - array - "null" given_name: description: "The givenName (G) elements of the Distinguished Name (OID: 2.5.4.42)." items: type: string type: - array - "null" jurisdiction_country: description: "The jurisdictionCountry elements of the Distinguished Name (OID: 1.3.6.1.4.1.311.60.2.1.3)." items: type: string type: - array - "null" jurisdiction_locality: description: "The jurisdictionLocality elements of the Distinguished Name (OID: 1.3.6.1.4.1.311.60.2.1.1)." items: type: string type: - array - "null" jurisdiction_province: description: "The jurisdictionStateOrProvince elements of the Distinguished Name (OID: 1.3.6.1.4.1.311.60.2.1.2)." items: type: string type: - array - "null" locality: description: "The localityName (L) elements of the Distinguished Name (OID: 2.5.4.7)." items: type: string type: - array - "null" organization: description: "The organizationName (O) elements of the Distinguished Name (OID: 2.5.4.10)." items: type: string type: - array - "null" organization_id: items: type: string type: - array - "null" organizational_unit: description: "The organizationalUnit (OU) elements of the Distinguished Name (OID: 2.5.4.11)." items: type: string type: - array - "null" postal_code: description: "The postalCode elements of the Distinguished Name (OID: 2.5.4.17)." items: type: string type: - array - "null" province: description: "The stateOrProvinceName (ST) elements of the Distinguished Name (OID: 2.5.4.8)." items: type: string type: - array - "null" serial_number: description: "The serialNumber elements of the Distinguished Name (OID: 2.5.4.5)." items: type: string type: - array - "null" street_address: description: "The streetAddress (STREET) elements of the Distinguished Name (OID: 2.5.4.9)." items: type: string type: - array - "null" surname: description: "The surname (SN) elements of the Distinguished Name (OID: 2.5.4.4)." items: type: string type: - array - "null" type: object Dnp3: additionalProperties: false type: object Dns: additionalProperties: false properties: additionals: description: A list of resource records (RRs) contained in the ADDITIONAL section of the response. items: $ref: "#/components/schemas/Dns_ResourceRecord" type: - array - "null" answers: description: A list of resource records (RRs) contained in the ANSWER section of the response. items: $ref: "#/components/schemas/Dns_ResourceRecord" type: - array - "null" authorities: description: A list of resource records (RRs) contained in the AUTHORITIES section of the response. items: $ref: "#/components/schemas/Dns_ResourceRecord" type: - array - "null" edns: $ref: "#/components/schemas/Dns_EDns" questions: description: A list of resource records (RRs) contained in the QUESTION section of the response, which may echo the request that the server is responding to. items: $ref: "#/components/schemas/Dns_ResourceRecord" type: - array - "null" r_code: description: A enumerated field indicating the result of the request. The most common values are defined in RFC 1035. enum: - "" - success - format_error - server_failure - name_error - not_implemented - refused - yx_domain - yx_rrset - nx_rrset - not_auth - not_zone - bad_sig - bad_key - bad_time - bad_mode - bad_name - bad_alg - bad_trunc - bad_cookie type: string resolves_correctly: description: Whether the server returns an IP address for ip.parrotdns.com that matches the authoritative server, which is controlled by Censys. type: boolean server_type: description: An enumerated value indicating the behavior of the server. An AUTHORITATIVE server fulfills requests for domain names it controls, which are not listed by the server. FORWARDING and RECURSIVE_RESOLVER servers fulfill requests indirectly for domain names they do not control. A RECURSIVE_RESOLVER will query ip.parrotdns.com itself, resulting in its own IP address being present in the dns.answers.response field. enum: - "" - recursive_resolver - authoritative - forwarding - redirecting type: string version: type: string type: object DnsIpResolutionBoundResponse: additionalProperties: false properties: ip: description: The IP address that was queried. type: string next_page_token: description: A token that can be used to retrieve the next page of records. type: string records: description: The list of domain names that resolved to this IP. items: $ref: "#/components/schemas/DnsIpResolutionRecord" type: - array - "null" total_records: description: The number of records that exist in total across all pages. format: int64 type: integer required: - ip - next_page_token - records - total_records type: object DnsIpResolutionRangeRecord: additionalProperties: false properties: domain: description: The domain name that resolved to this IP. type: string first_seen: description: The time this record was first observed. format: date-time type: string last_seen: description: The time this record was last observed. format: date-time type: string record_type: description: Either A or AAAA. enum: - A - AAAA type: string required: - domain - first_seen - last_seen - record_type type: object DnsIpResolutionRangeResponse: additionalProperties: false properties: ip: description: The IP address that was queried. type: string next_page_token: description: A token that can be used to retrieve the next page of records. type: string records: description: The list of domain names that resolved to this IP. items: $ref: "#/components/schemas/DnsIpResolutionRangeRecord" type: - array - "null" total_records: description: The number of records that exist in total across all pages. format: int64 type: integer required: - ip - next_page_token - records - total_records type: object DnsIpResolutionRecord: additionalProperties: false properties: domain: description: The domain name that resolved to this IP. type: string first_seen: description: The time this record was first observed. format: date-time type: string last_seen: description: The time this record was last observed. format: date-time type: string record_type: description: Either A or AAAA. enum: - A - AAAA type: string required: - domain - first_seen - last_seen - record_type type: object DnsNameResolutionBoundResponse: additionalProperties: false properties: name: description: The domain name that was queried. type: string next_page_token: description: A token that can be used to retrieve the next page of records. type: string records: description: The list of DNS records. items: $ref: "#/components/schemas/DnsResolutionRecord" type: - array - "null" total_records: description: The number of records that exist in total across all pages. format: int64 type: integer required: - name - next_page_token - records - total_records type: object DnsNameResolutionRangeResponse: additionalProperties: false properties: name: description: The domain name that was queried. type: string next_page_token: description: A token that can be used to retrieve the next page of records. type: string records: description: The list of DNS observation windows. items: $ref: "#/components/schemas/DnsResolutionRangeRecord" type: - array - "null" total_records: description: The number of records that exist in total across all pages. format: int64 type: integer required: - name - next_page_token - records - total_records type: object DnsResolutionRangeRecord: additionalProperties: false properties: first_observed: description: When this record was first observed in this window. format: date-time type: string ip: description: The IP of the record. IPv4 if the record_type is A. IPv6 if the record_type is AAAA. Otherwise not present. type: string last_observed: description: When this record was last observed in this window. format: date-time type: string mail_server: description: The MX mail server. Only present when record_type is MX. Otherwise not present. type: string mname: description: The primary name server. Only present when record_type is SOA. Otherwise not present. type: string name_server: description: The name server. Only present when record_type is NS. Otherwise not present. type: string priority: description: The MX priority. Only present when record_type is MX. Otherwise not present. format: int64 type: integer record_type: description: The record type. Either A, AAAA, MX, NS, SOA, or TXT. enum: - A - AAAA - MX - NS - SOA - TXT type: string rname: description: The responsible contact, as email. Only present when record_type is SOA. Otherwise not present. type: string value: description: Full, untruncated string. Only present when record_type is TXT. Otherwise not present. type: string required: - first_observed - last_observed - record_type type: object DnsResolutionRecord: additionalProperties: false properties: first_seen: description: The time this record was first observed. format: date-time type: string ip: description: The IP of the record. IPv4 if the record_type is A. IPv6 if the record_type is AAAA. Otherwise not present. type: string last_seen: description: The time this record was last observed. format: date-time type: string mail_server: description: The MX mail server. Only present when record_type is MX. Otherwise not present. type: string mname: description: The primary name server. Only present when record_type is SOA. Otherwise not present. type: string name_server: description: The name server. Only present when record_type is NS. Otherwise not present. type: string priority: description: The MX priority. Only present when record_type is MX. Otherwise not present. format: int64 type: integer record_type: description: The record type. Either A, AAAA, MX, NS, SOA, or TXT. enum: - A - AAAA - MX - NS - SOA - TXT type: string rname: description: The responsible contact, as email. Only present when record_type is SOA. Otherwise not present. type: string value: description: Full, untruncated string. Only present when record_type is TXT. Otherwise not present. type: string required: - first_seen - last_seen - record_type type: object Dns_EDns: additionalProperties: false properties: do: type: boolean options: items: type: string type: - array - "null" udp: format: int32 minimum: 0 type: integer version: format: int32 minimum: 0 type: integer type: object Dns_ResourceRecord: additionalProperties: false properties: name: description: The Fully Qualified Domain Name (FQDN) this RR is for. type: string response: description: The RDATA field of the RR. type: string type: description: An enumerated field indicating what type of data is in the "services.dns.additionals.response" field. For example, "A" signifies that the value in "services.dns.additionals.response" is an IPv4 address for the FQDN in "services.dns.additionals.name". enum: - "" - a - txt - ns type: string type: object DomainError: additionalProperties: false properties: detail: description: A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: "#/components/schemas/ErrorDetail" type: - array - "null" instance: description: A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string type: object DsaPublicKey: additionalProperties: false properties: g: format: hex type: string p: format: hex type: string q: format: hex type: string "y": format: hex type: string type: object Dtls: additionalProperties: false type: object DvrIp: additionalProperties: false properties: access_url: type: string function_capability: type: string function_list: type: string hard_drive: type: string language_support: type: string network_status: type: string oem_info: type: string partition_capability: $ref: "#/components/schemas/DvrIp_PartitionCapability" serial: type: string split_screen_capability: type: string version: type: string wireless_alarm_capability: type: string type: object DvrIp_PartitionCapability: additionalProperties: false properties: max_partition_number: format: int32 type: integer supported: type: boolean type: object ECDSACryptographicKey: additionalProperties: false properties: b: format: base64 type: string curve: type: string gx: format: base64 type: string gy: format: base64 type: string length: format: int32 minimum: 0 type: integer "n": format: base64 type: string p: format: base64 type: string pub: format: base64 type: string x: format: base64 type: string "y": format: base64 type: string type: object ED25519CryptographicKey: additionalProperties: false properties: public_bytes: format: base64 type: string type: object EPSS: additionalProperties: false properties: percentile: format: double type: number score: format: double type: number type: object EcdsaPublicKey: additionalProperties: false properties: b: format: hex type: string curve: type: string gx: format: hex type: string gy: format: hex type: string length: format: int64 type: integer "n": format: hex type: string p: format: hex type: string pub: format: hex type: string x: format: hex type: string "y": format: hex type: string type: object EdiPartyName: additionalProperties: false properties: name_assigner: type: string party_name: type: string type: object Eip: additionalProperties: false properties: identity: $ref: "#/components/schemas/Eip_Identity" interfaces: items: $ref: "#/components/schemas/Eip_Interface" type: - array - "null" services: items: $ref: "#/components/schemas/Eip_Service" type: - array - "null" type: object Eip_Identity: additionalProperties: false properties: device_type: type: string device_type_code: format: int32 minimum: 0 type: integer product_code: format: int32 minimum: 0 type: integer product_name: type: string revision: type: string serial_number: format: int32 minimum: 0 type: integer socket_addr: type: string socket_port: format: int32 minimum: 0 type: integer state: format: int32 minimum: 0 type: integer status: format: int32 minimum: 0 type: integer vendor_id: type: string vendor_name: type: string type: object Eip_Interface: additionalProperties: false properties: index: format: int32 minimum: 0 type: integer name: type: string type: object Eip_Service: additionalProperties: false properties: capabilities: format: int32 minimum: 0 type: integer service_name: type: string supports_tcp: type: boolean supports_udp: type: boolean type: object ElasticSearch: additionalProperties: false properties: error_message: $ref: "#/components/schemas/ElasticSearch_ErrorMessage" results_node_info: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo" system_info: $ref: "#/components/schemas/ElasticSearch_SystemInfo" type: object ElasticSearch_ErrorMessage: additionalProperties: false properties: header: type: string reason: type: string type: type: string type: object ElasticSearch_ResultsNodeInfo: additionalProperties: false properties: cluster_combined_info: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo" node_info: items: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes" type: - array - "null" type: object ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo: additionalProperties: false properties: filesystem: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo_Filesystem" indices: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo_Indices" name: type: string status: type: string timestamp: format: int64 type: integer uuid: type: string type: object ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo_Filesystem: additionalProperties: false properties: available: type: string available_in_bytes: format: int64 type: integer free: type: string free_in_bytes: format: int64 type: integer total: type: string total_in_bytes: format: int64 type: integer type: object ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo_Indices: additionalProperties: false properties: count: format: int64 type: integer docs: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo_Indices_Docs" store: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo_Indices_Store" type: object ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo_Indices_Docs: additionalProperties: false properties: count: format: int64 type: integer deleted: format: int64 type: integer type: object ElasticSearch_ResultsNodeInfo_ClusterCombinedInfo_Indices_Store: additionalProperties: false properties: reserved_in_bytes: format: int64 type: integer size_in_bytes: format: int64 type: integer type: object ElasticSearch_ResultsNodeInfo_Nodes: additionalProperties: false properties: node_data: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData" node_name: type: string type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData: additionalProperties: false properties: build_flavor: type: string build_hash: type: string build_type: type: string host: type: string ingest_processors: items: type: string type: - array - "null" ip: type: string ip_raw: type: string jvm: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData_JVM" modules: items: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData_Modules" type: - array - "null" name: type: string os: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData_OS" roles: items: type: string type: - array - "null" settings: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData_NodeSettings" thread_pool_list: items: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData_ThreadPool" type: - array - "null" total_indexing_buffer: format: int64 type: integer version: type: string type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData_JVM: additionalProperties: false properties: gc: items: type: string type: - array - "null" input_args: items: type: string type: - array - "null" memory_pools: items: type: string type: - array - "null" start_time: type: string start_time_ms: format: int64 type: integer version: type: string vm_name: type: string vm_vendor: type: string vm_version: type: string type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData_Modules: additionalProperties: false properties: class_name: type: string desc: type: string elastic_version: type: string ext_plugins: items: type: string type: - array - "null" has_native_ctrl: type: boolean java_version: type: string name: type: string version: type: string type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData_NodeSettings: additionalProperties: false properties: cluster_name: type: string node: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData_NodeSettings_Node" type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData_NodeSettings_Node: additionalProperties: false properties: attr: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData_NodeSettings_Node_Attr" name: type: string type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData_NodeSettings_Node_Attr: additionalProperties: false properties: ml: $ref: "#/components/schemas/ElasticSearch_ResultsNodeInfo_Nodes_NodeData_NodeSettings_Node_Attr_ML" xpack_installed: type: string type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData_NodeSettings_Node_Attr_ML: additionalProperties: false properties: enabled: type: string machine_memory: type: string max_open_jobs: type: string type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData_OS: additionalProperties: false properties: allocated_proc: format: int32 type: integer arch: type: string available_proc: format: int32 type: integer name: type: string pretty_name: type: string refresh_interval_ms: format: int64 type: integer version: type: string type: object ElasticSearch_ResultsNodeInfo_Nodes_NodeData_ThreadPool: additionalProperties: false properties: keep_alive: type: string max: format: int32 type: integer min: format: int32 type: integer queue_size: format: int32 type: integer type: type: string type: object ElasticSearch_SystemInfo: additionalProperties: false properties: cluster_uuid: type: string name: type: string tagline: type: string version: $ref: "#/components/schemas/ElasticSearch_SystemInfo_Ver" type: object ElasticSearch_SystemInfo_Ver: additionalProperties: false properties: build_date: type: string build_flavor: type: string build_hash: type: string build_snapshot: type: boolean build_type: type: string lucene_version: type: string min_idx_compat_ver: type: string min_wire_compat_ver: type: string number: type: string type: object ElfFile: additionalProperties: false properties: class: type: string data: type: string machine: type: string os_abi: type: string type: type: string type: object EndpointScan: additionalProperties: false properties: banner: format: utf8 type: string banner_hash_sha256: format: hex type: string chrome_devtools: $ref: "#/components/schemas/ChromeDevtools" cobalt_strike: $ref: "#/components/schemas/CobaltStrike" elasticsearch: $ref: "#/components/schemas/ElasticSearch" endpoint_type: type: string fortigate: $ref: "#/components/schemas/Fortigate" graphql: $ref: "#/components/schemas/Graphql" hostname: type: string http: $ref: "#/components/schemas/Http" ip: type: string is_success: type: boolean ivanti_avalanche: $ref: "#/components/schemas/IvantiAvalanche" jenkins: $ref: "#/components/schemas/Jenkins" kubernetes: $ref: "#/components/schemas/Kubernetes" mcp: $ref: "#/components/schemas/Mcp" ollama: $ref: "#/components/schemas/Ollama" open_directory: $ref: "#/components/schemas/OpenDirectory" path: type: string plex_media_server: $ref: "#/components/schemas/PlexMediaServer" port: format: int32 minimum: 0 type: integer pprof: $ref: "#/components/schemas/Pprof" prometheus: $ref: "#/components/schemas/Prometheus" prometheus_target: $ref: "#/components/schemas/PrometheusTarget" redlion_web: $ref: "#/components/schemas/RedlionWeb" scada_view: $ref: "#/components/schemas/ScadaView" scan_time: type: string screenshots: items: $ref: "#/components/schemas/Screenshot" type: - array - "null" tls: $ref: "#/components/schemas/Tls" transport_protocol: enum: - "" - tcp - udp - icmp - quic type: string type: object EndpointScanState: additionalProperties: false properties: banner: format: utf8 type: string banner_hash_sha256: format: hex type: string chrome_devtools: $ref: "#/components/schemas/ChromeDevtools" cobalt_strike: $ref: "#/components/schemas/CobaltStrike" elasticsearch: $ref: "#/components/schemas/ElasticSearch" endpoint_type: type: string extracted: $ref: "#/components/schemas/ExtractedEndpointData" fortigate: $ref: "#/components/schemas/Fortigate" graphql: $ref: "#/components/schemas/Graphql" hostname: type: string http: $ref: "#/components/schemas/Http" ip: type: string ivanti_avalanche: $ref: "#/components/schemas/IvantiAvalanche" jenkins: $ref: "#/components/schemas/Jenkins" kubernetes: $ref: "#/components/schemas/Kubernetes" mcp: $ref: "#/components/schemas/Mcp" ollama: $ref: "#/components/schemas/Ollama" open_directory: $ref: "#/components/schemas/OpenDirectory" path: type: string plex_media_server: $ref: "#/components/schemas/PlexMediaServer" port: format: int32 minimum: 0 type: integer pprof: $ref: "#/components/schemas/Pprof" prometheus: $ref: "#/components/schemas/Prometheus" prometheus_target: $ref: "#/components/schemas/PrometheusTarget" redlion_web: $ref: "#/components/schemas/RedlionWeb" scada_view: $ref: "#/components/schemas/ScadaView" scan_time: type: string screenshots: items: $ref: "#/components/schemas/Screenshot" type: - array - "null" transport_protocol: enum: - "" - tcp - udp - icmp - quic type: string type: object EndpointScanned: additionalProperties: false properties: diff: additionalProperties: $ref: "#/components/schemas/FieldDiff" type: object scan: $ref: "#/components/schemas/EndpointScan" type: object Epmd: additionalProperties: false properties: names: items: type: string type: - array - "null" type: object ErrorDetail: additionalProperties: false properties: location: description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object ErrorModel: additionalProperties: false properties: detail: description: A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: "#/components/schemas/ErrorDetail" type: - array - "null" instance: description: A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string type: object Etcd: additionalProperties: false properties: v2: $ref: "#/components/schemas/Etcd_V2" v3: $ref: "#/components/schemas/Etcd_V3" version: $ref: "#/components/schemas/Etcd_Version" type: object Etcd_V2: additionalProperties: false properties: auth: $ref: "#/components/schemas/Auth" members: items: $ref: "#/components/schemas/Members" type: - array - "null" total_keys: format: int32 minimum: 0 type: integer type: object Etcd_V3: additionalProperties: false properties: auth: $ref: "#/components/schemas/Auth" members: items: $ref: "#/components/schemas/Members" type: - array - "null" total_keys: format: int32 minimum: 0 type: integer type: object Etcd_Version: additionalProperties: false properties: cluster: type: string server: type: string type: object Ethereum: additionalProperties: false properties: accounts: items: type: string type: - array - "null" hashrate: type: string version: $ref: "#/components/schemas/Ethereum_Version" type: object Ethereum_Version: additionalProperties: false properties: client: type: string compiler: type: string platform: type: string trailing: type: string version: type: string type: object EventAssetChange: additionalProperties: false properties: change_type: enum: - added - removed type: string event_time: format: date-time type: string reason: type: string required: - event_time - reason - change_type type: object EventStatusChange: additionalProperties: false properties: event_time: format: date-time type: string new_status: enum: - active - populating - paused - archived type: string old_status: enum: - active - populating - paused - archived type: string reason: type: string required: - event_time - new_status type: object EventsCapabilities: additionalProperties: false properties: max_notification_producers: format: int32 minimum: 0 type: integer max_pull_points: format: int32 minimum: 0 type: integer ws_pausable_subscription_manager_interface_support: type: boolean ws_pull_point_support: type: boolean ws_subscription_policy_support: type: boolean type: object Evidence: additionalProperties: false properties: data_path: type: string exists: type: boolean found_value: type: string literal_match: type: string negative: type: boolean proprietary: type: boolean regex: type: string semver_expression: type: string type: object Export: additionalProperties: false properties: details: type: string max_payload_size: format: int32 minimum: 0 type: integer min_block_size: format: int32 minimum: 0 type: integer name: type: string preferred_block_size: format: int32 minimum: 0 type: integer size: format: int64 minimum: 0 type: integer transmit_flags: items: type: string type: - array - "null" type: object ExportList: additionalProperties: false properties: directory: type: string groups: items: type: string type: - array - "null" type: object ExtendedKeyUsage: additionalProperties: false properties: any: type: boolean apple_code_signing: type: boolean apple_code_signing_development: type: boolean apple_code_signing_third_party: type: boolean apple_crypto_development_env: type: boolean apple_crypto_env: type: boolean apple_crypto_maintenance_env: type: boolean apple_crypto_production_env: type: boolean apple_crypto_qos: type: boolean apple_crypto_test_env: type: boolean apple_crypto_tier0_qos: type: boolean apple_crypto_tier1_qos: type: boolean apple_crypto_tier2_qos: type: boolean apple_crypto_tier3_qos: type: boolean apple_ichat_encryption: type: boolean apple_ichat_signing: type: boolean apple_resource_signing: type: boolean apple_software_update_signing: type: boolean apple_system_identity: type: boolean client_auth: type: boolean code_signing: type: boolean dvcs: type: boolean eap_over_lan: type: boolean eap_over_ppp: type: boolean email_protection: type: boolean ipsec_end_system: type: boolean ipsec_intermediate_system_usage: type: boolean ipsec_tunnel: type: boolean ipsec_user: type: boolean microsoft_ca_exchange: type: boolean microsoft_cert_trust_list_signing: type: boolean microsoft_csp_signature: type: boolean microsoft_document_signing: type: boolean microsoft_drm: type: boolean microsoft_drm_individualization: type: boolean microsoft_efs_recovery: type: boolean microsoft_embedded_nt_crypto: type: boolean microsoft_encrypted_file_system: type: boolean microsoft_enrollment_agent: type: boolean microsoft_kernel_mode_code_signing: type: boolean microsoft_key_recovery_21: type: boolean microsoft_key_recovery_3: type: boolean microsoft_license_server: type: boolean microsoft_licenses: type: boolean microsoft_lifetime_signing: type: boolean microsoft_mobile_device_software: type: boolean microsoft_nt5_crypto: type: boolean microsoft_oem_whql_crypto: type: boolean microsoft_qualified_subordinate: type: boolean microsoft_root_list_signer: type: boolean microsoft_server_gated_crypto: type: boolean microsoft_sgc_serialized: type: boolean microsoft_smart_display: type: boolean microsoft_smartcard_logon: type: boolean microsoft_system_health: type: boolean microsoft_system_health_loophole: type: boolean microsoft_timestamp_signing: type: boolean microsoft_whql_crypto: type: boolean netscape_server_gated_crypto: type: boolean ocsp_signing: type: boolean sbgp_cert_aa_service_auth: type: boolean server_auth: type: boolean time_stamping: type: boolean unknown: items: type: string type: - array - "null" type: object Extension: additionalProperties: false properties: critical: type: boolean id: type: string value: format: hex type: string type: object ExtractedEndpointData: additionalProperties: false properties: analytics_services: items: $ref: "#/components/schemas/ExtractedEndpointData_AnalyticsService" type: - array - "null" copyrights: items: $ref: "#/components/schemas/ExtractedEndpointData_Copyright" type: - array - "null" ip_addresses: items: type: string type: - array - "null" languages: items: type: string type: - array - "null" links: items: type: string type: - array - "null" mac_addresses: items: type: string type: - array - "null" type: object ExtractedEndpointData_AnalyticsService: additionalProperties: false properties: ids: items: type: string type: - array - "null" provider: type: string type: object ExtractedEndpointData_Copyright: additionalProperties: false properties: end_year: format: int32 type: integer holder: type: string start_year: format: int32 type: integer text: type: string type: object FieldDiff: additionalProperties: false properties: new: type: string old: type: string type: object FieldValuePair: additionalProperties: false properties: field: description: The field to match examples: - host.services.port type: string value: description: The value to match examples: - "80" type: string required: - field - value type: object FlashSocketPolicy: additionalProperties: false properties: allow_access_from: items: $ref: "#/components/schemas/FlashSocketPolicy_AllowAccessFrom" type: - array - "null" policy: type: string site_control: type: string type: object FlashSocketPolicy_AllowAccessFrom: additionalProperties: false properties: domain: type: string secure: type: boolean to_ports: type: string type: object FloatValue: additionalProperties: false properties: value: format: float type: number type: object Fortigate: additionalProperties: false properties: api_version: type: string build: format: int32 type: integer serial: type: string status_code: format: int32 type: integer status_msg: type: string version: type: string type: object ForwardDnsResolved: additionalProperties: false properties: name: type: string resolve_time: type: string type: object Fox: additionalProperties: false properties: app_name: type: string app_version: type: string auth_agent_type: type: string brand_id: type: string host_address: type: string host_id: type: string hostname: type: string id: format: int32 minimum: 0 type: integer language: type: string os_name: type: string os_version: type: string station_name: type: string sys_info: type: string time_zone: type: string version: type: string vm_name: type: string vm_uuid: type: string vm_version: type: string type: object Frps: additionalProperties: false properties: error: type: string run_id: type: string version: type: string type: object Ftp: additionalProperties: false properties: auth_ssl_response: format: utf8 type: string auth_tls_response: format: utf8 type: string implicit_tls: type: boolean status_code: format: int32 type: integer status_meaning: type: string type: object Gearman: additionalProperties: false properties: status: items: $ref: "#/components/schemas/Status" type: - array - "null" version: type: string workers: items: $ref: "#/components/schemas/Worker" type: - array - "null" type: object Gemini: additionalProperties: false properties: body: format: utf8 type: string client_cert_required: type: boolean meta: type: string status_code: format: int32 type: integer type: object GeneralNames: additionalProperties: false properties: directory_names: description: The parsed directoryName entries in the GeneralName. items: $ref: "#/components/schemas/DistinguishedName" type: - array - "null" dns_names: description: The parsed dNSName entries in the GeneralName. items: type: string type: - array - "null" edi_party_names: description: The parsed eDIPartyName entries in the GeneralName. items: $ref: "#/components/schemas/EdiPartyName" type: - array - "null" email_addresses: description: The parsed rfc822Name entries in the GeneralName. items: type: string type: - array - "null" ip_addresses: description: The parsed ipAddress entries in the GeneralName. items: type: string type: - array - "null" other_names: description: The parsed otherName entries in the GeneralName. An arbitrary binary value identified by an OID. items: $ref: "#/components/schemas/OtherName" type: - array - "null" registered_ids: description: The parsed registeredID entries in the GeneralName. Stored in dotted-decimal format. items: type: string type: - array - "null" uniform_resource_identifiers: description: The parsed uniformResourceIdentifier entries in the GeneralName. items: type: string type: - array - "null" type: object GeneralSubtreeIp: additionalProperties: false properties: begin: description: The first IP address in the range. type: string cidr: description: The CIDR specifying the subtree. type: string end: description: The last IP address in the range. type: string mask: description: The subnet mask of the CIDR. type: string type: object Graphql: additionalProperties: false properties: response: type: string supports_introspection: type: boolean type: object Greynoise: additionalProperties: false properties: actor: description: The actor that was observed. type: string classification: description: The classification of the IP address. type: string last_observed_time: description: The last time the IP address was observed. type: string tags: description: The tags associated with the IP address. items: $ref: "#/components/schemas/Greynoise_Tag" type: - array - "null" type: object Greynoise_Tag: additionalProperties: false properties: name: description: The name of the tag. type: string type: object Hajime: additionalProperties: false properties: public_key: format: hex type: string type: object HashObservationOnHostRange: additionalProperties: false properties: end_time: description: When the observation was last seen format: date-time type: string ip: description: IP address of the host type: string observation_type: description: Observation type selected in the request type: string observation_value: description: Observed value for the selected observation type type: string port: description: Port number type: string start_time: description: When the observation was first seen format: date-time type: string transport_protocol: description: Transport protocol when present for the selected timeline type: string required: - ip - port - observation_type - observation_value - start_time - end_time type: object HashObservationsOnHostResponse: additionalProperties: false properties: next_page_token: description: A token that can be used to retrieve the next page of ranges. type: string ranges: description: The list of observation ranges matching the request. items: $ref: "#/components/schemas/HashObservationOnHostRange" type: - array - "null" required: - ranges - next_page_token type: object HidVertx: additionalProperties: false properties: firmware_date: type: string id: type: string ip: type: string mac_address: type: string make_model: type: string model: type: string version: type: string type: object Hikvision: additionalProperties: false properties: custom_version: type: string platforms: items: $ref: "#/components/schemas/Hikvision_Platform" type: - array - "null" plugin_version: type: string web_version: type: string type: object Hikvision_Platform: additionalProperties: false properties: libraries: items: $ref: "#/components/schemas/Hikvision_Platform_Library" type: - array - "null" name: type: string type: object Hikvision_Platform_Library: additionalProperties: false properties: name: type: string version: type: string type: object Host: additionalProperties: false properties: autonomous_system: $ref: "#/components/schemas/Routing" dns: $ref: "#/components/schemas/HostDns" greynoise: $ref: "#/components/schemas/Greynoise" hardware: $ref: "#/components/schemas/Attribute" ip: type: string labels: items: $ref: "#/components/schemas/Label" type: - array - "null" location: $ref: "#/components/schemas/Location" network: description: Information about what type of network the host belongs to. items: $ref: "#/components/schemas/NetworkClassification" type: - array - "null" operating_system: $ref: "#/components/schemas/Attribute" privacy: description: Information about privacy services used by the IP, such as VPNs, Proxies, or Tor. items: $ref: "#/components/schemas/Privacy" type: - array - "null" reputation: $ref: "#/components/schemas/Reputation" service_count: format: int32 type: integer services: items: $ref: "#/components/schemas/Service" type: - array - "null" whois: $ref: "#/components/schemas/Whois" type: object HostAsset: additionalProperties: false properties: extensions: additionalProperties: {} type: object resource: $ref: "#/components/schemas/Host" required: - resource - extensions type: object HostAssetWithMatchedServices: additionalProperties: false properties: extensions: additionalProperties: {} type: object matched_services: description: The host services that match the query. items: $ref: "#/components/schemas/MatchedService" type: - array - "null" resource: $ref: "#/components/schemas/Host" required: - resource - extensions type: object HostDns: additionalProperties: false properties: forward_dns: additionalProperties: $ref: "#/components/schemas/HostDns_ForwardResolution" type: object names: items: type: string type: - array - "null" reverse_dns: $ref: "#/components/schemas/HostDns_ReverseResolution" type: object HostDns_ForwardResolution: additionalProperties: false properties: name: type: string record_type: enum: - "" - a - aaaa type: string resolve_time: type: string server: type: string type: object HostDns_ReverseResolution: additionalProperties: false properties: names: items: type: string type: - array - "null" resolve_time: type: string server: type: string type: object HostObservationRange: additionalProperties: false properties: end_time: format: date-time type: string ip: type: string port: format: int32 type: integer protocols: items: type: string type: - array - "null" start_time: format: date-time type: string transport_protocol: type: string required: - ip - port - transport_protocol - protocols - start_time - end_time type: object HostObservationResponse: additionalProperties: false properties: next_page_token: type: string ranges: items: $ref: "#/components/schemas/HostObservationRange" type: - array - "null" total_results: format: int64 type: integer required: - ranges - total_results type: object HostTimeline: additionalProperties: false properties: events: items: $ref: "#/components/schemas/HostTimelineEventAsset" type: - array - "null" scanned_to: format: date-time type: string required: - events - scanned_to type: object HostTimelineEvent: additionalProperties: false properties: endpoint_scanned: $ref: "#/components/schemas/EndpointScanned" event_time: type: string forward_dns_resolved: $ref: "#/components/schemas/ForwardDnsResolved" jarm_scanned: $ref: "#/components/schemas/JarmScanned" location_updated: $ref: "#/components/schemas/LocationUpdated" reverse_dns_resolved: $ref: "#/components/schemas/ReverseDnsResolved" route_updated: $ref: "#/components/schemas/RouteUpdated" service_scanned: $ref: "#/components/schemas/ServiceScanned" whois_updated: $ref: "#/components/schemas/WhoisUpdated" type: object HostTimelineEventAsset: additionalProperties: false properties: extensions: additionalProperties: {} type: object resource: $ref: "#/components/schemas/HostTimelineEvent" required: - resource - extensions type: object Http: additionalProperties: false properties: body: description: The body of the HTTP response. For hosts without a name, the first 64KB are available. For hosts with a name, only 6KB are available. format: utf8 type: string body_hash_sha1: format: hex type: string body_hash_sha256: format: hex type: string body_hash_tlsh: format: hex type: string body_size: description: The length, in bytes, of services.http.response.body; at most, 64KB. format: int32 type: integer favicons: items: $ref: "#/components/schemas/Http_Favicon" type: - array - "null" headers: additionalProperties: $ref: "#/components/schemas/Http_RepeatedHeaders" description: The key-value header pairs included in the response. type: object html_tags: description: A list of the and <meta> tags from services.http.response.body. format: utf8 items: type: string type: - array - "null" html_title: description: "The title of the HTML page: the inner contents of the <title> tag in the response body, if present." format: utf8 type: string network_log: $ref: "#/components/schemas/NetworkLog" description: List of all resources fetched when visiting this page as browser protocol: description: The protocol field of the response, which includes the claimed HTTP version number. type: string redirect_chain: description: If the scan redirects, the list of followup scans performed items: $ref: "#/components/schemas/Http_RedirectChainLink" type: - array - "null" status_code: description: A 3-digit integer result code indicating the result of the services.http.request. format: int32 type: integer status_reason: description: A human-readable phrase describing the status code. type: string supported_versions: items: type: string type: - array - "null" uri: description: The full path used to make the request, which includes the scheme, host, port (when non-standard), and endpoint. type: string type: object Http_Favicon: additionalProperties: false properties: hash_md5: format: hex type: string hash_phash: description: A 64-bit 'perceptual' hash of the favicon format: hex type: string hash_sha256: format: hex type: string hash_shodan: description: A hash expressed as a signed decimal integer, provided for compatability with Shodan search. format: int32 type: integer name: description: "The URI used to retrieve the favicon, which most commonly use the http(s) or data schemes. URIs using the data scheme are truncated: the first 48 and last 24 characters are preserved." type: string size: description: The size of the favicon retrieved, in bytes. format: int32 type: integer type: object Http_RedirectChainLink: additionalProperties: false properties: hostname: type: string path: type: string port: format: int32 minimum: 0 type: integer reason: type: string scheme: type: string transport_protocol: enum: - "" - tcp - udp - icmp - quic type: string type: object Http_RepeatedHeaders: additionalProperties: false properties: headers: description: The values provided in the corresponding header. format: utf8 items: type: string type: - array - "null" type: object Ibmnje: additionalProperties: false properties: ohost: type: string oip: type: string reason: format: int32 minimum: 0 type: integer rhost: type: string rip: type: string type: type: string type: object Icap: additionalProperties: false properties: options_response: $ref: "#/components/schemas/Icap_OptionsResponse" type: object Icap_OptionsResponse: additionalProperties: false properties: allow_204: type: boolean icap_version: type: string istag: type: string max_connections: format: int32 type: integer methods: items: type: string type: - array - "null" options_ttl: format: int32 type: integer preview: format: int32 type: integer server_header: type: string service: type: string service_id: type: string status_code: format: int32 type: integer status_text: type: string type: object Ike: additionalProperties: false properties: v1: $ref: "#/components/schemas/Ike_V1" v2: $ref: "#/components/schemas/Ike_V2" type: object Ike_V1: additionalProperties: false properties: accepted_proposal: description: Did the host accept our security proposal? When false, the host responded with an error. type: boolean notify_message_types: description: Which types of NOTIFY messages did the host send us? items: format: int32 minimum: 0 type: integer type: - array - "null" vendor_ids: description: The list of Vendor ID "extensions" the host claimed to support in its handshake format: utf8 items: type: string type: - array - "null" type: object Ike_V2: additionalProperties: false properties: accepted_proposal: type: boolean notify_message_types: items: format: int32 minimum: 0 type: integer type: - array - "null" vendor_ids: format: utf8 items: type: string type: - array - "null" type: object ImageCapabilities: additionalProperties: false properties: image_stabilization: type: boolean type: object Imap: additionalProperties: false properties: start_tls: description: The server's response to the STARTTLS command. format: utf8 type: string type: object InviteMemberInputBody: additionalProperties: false properties: email: description: Email of the user examples: - user@example.com format: email type: string required: - email type: object Iota: additionalProperties: false properties: v0_info: $ref: "#/components/schemas/NodeInfoV0" v1_info: $ref: "#/components/schemas/NodeInfoV1" v2_info: $ref: "#/components/schemas/NodeInfoV2" type: object Ipmi: additionalProperties: false properties: capabilities: $ref: "#/components/schemas/Ipmi_Capabilities" description: The Get Channel Authentication Capabilities response (section 22.13) command_payload: $ref: "#/components/schemas/Ipmi_CommandPayload" description: The IPMI command payload raw: description: The raw data returned by the server format: hex type: string rmcp_header: $ref: "#/components/schemas/Ipmi_RMCPHeader" description: The RMCP header of the response, (section 13.1.3) session_header: $ref: "#/components/schemas/Ipmi_SessionHeader" description: The IPMI sesssion header of the response type: object Ipmi_Capabilities: additionalProperties: false properties: auth_status: $ref: "#/components/schemas/Ipmi_Capabilities_AuthStatus" description: The authentication status channel_number: description: The response channel number format: int32 type: integer completion_code: $ref: "#/components/schemas/Ipmi_Capabilities_CompletionCode" description: The status code of the response extended_capabilities: $ref: "#/components/schemas/Ipmi_Capabilities_ExtendedCapabilities" description: Extended auth capabilities (if present) oem_data: description: The OEM-specific data format: int32 type: integer oem_id: description: The 3-byte OEM identifier format: hex type: string supported_auth_types: $ref: "#/components/schemas/Ipmi_Capabilities_SupportedAuthTypes" description: The auth types supported by the server type: object Ipmi_Capabilities_AuthStatus: additionalProperties: false properties: anonymous_login_enabled: description: If true, the server allows anonymous login. type: boolean auth_each_message: description: If true, each message must be authenticated. type: boolean has_anonymous_users: description: If true, the server has anonymous users. type: boolean has_named_users: description: If true, the server supports named users. type: boolean two_key_login_required: description: The KG field. type: boolean user_auth_disabled: description: If true, user authentication is disabled. type: boolean type: object Ipmi_Capabilities_CompletionCode: additionalProperties: false properties: name: description: The human-readable name of the code type: string raw: description: The raw completion code format: int32 type: integer type: object Ipmi_Capabilities_ExtendedCapabilities: additionalProperties: false properties: supports_ipmi_v1_5: description: True if IPMI v1.5 is supported type: boolean supports_ipmi_v2_0: description: True if IPMI v2.0 is supported type: boolean type: object Ipmi_Capabilities_SupportedAuthTypes: additionalProperties: false properties: extended: description: If true, the extended capabilities are present. type: boolean md2: description: True if the MD2 AuthType is supported. type: boolean md5: description: True if the MD5 AuthType is supported. type: boolean none: description: True if the None AuthType is supported. type: boolean oem_proprietary: description: True if the OEM Proprietary AuthType is supported type: boolean password: description: True if the Password AuthType is supported. type: boolean raw: description: The raw byte, with the bit mask etc format: int32 type: integer type: object Ipmi_CommandPayload: additionalProperties: false properties: checksum_error: description: This is set to true if the values of chk1 / chk2 do not match the command data type: boolean data: description: The raw data. On success, this should be the value of the GetAuthenticationCapabilities resopnse format: hex type: string ipmi_command_number: $ref: "#/components/schemas/Ipmi_CommandPayload_CommandNumber" description: The parsed IPMI command number network_function_code: $ref: "#/components/schemas/Ipmi_CommandPayload_PackedNetFn" description: The NetFn and LUN requestor_sequence_number: description: The request sequence number. format: int32 type: integer type: object Ipmi_CommandPayload_CommandNumber: additionalProperties: false properties: name: description: The human-readable name of the cmd + NetFn type: string raw: description: The raw value of the cmd value format: int32 type: integer type: object Ipmi_CommandPayload_PackedNetFn: additionalProperties: false properties: logical_unit_number: $ref: "#/components/schemas/Ipmi_CommandPayload_PackedNetFn_LogicalUnitNumber" description: The parsed LUN (logical unit number -- the lower 2 bits of raw) net_fn: $ref: "#/components/schemas/Ipmi_CommandPayload_PackedNetFn_NetFn" description: The parsed NetFn value (the upper 6 bits of raw) raw: description: The raw value of the (NetFn << 2) | LUN format: int32 type: integer type: object Ipmi_CommandPayload_PackedNetFn_LogicalUnitNumber: additionalProperties: false properties: name: description: The human-readable name of the LUN type: string raw: description: The value of the LUN (3 bits) format: int32 type: integer type: object Ipmi_CommandPayload_PackedNetFn_NetFn: additionalProperties: false properties: is_request: description: True if the least-significant bit is zero type: boolean is_response: description: True if the least-significant bit is one type: boolean name: description: The human-readable name of the NetFn type: string raw: description: The raw value of the NetFn (6 bits, least significant indicates request/response) format: int32 type: integer value: description: The normalized value of the NetFn (i.e. raw & 0xfe, so it is always even) format: int32 type: integer type: object Ipmi_RMCPHeader: additionalProperties: false properties: message_class: $ref: "#/components/schemas/Ipmi_RMCPHeader_MessageClass" description: The class of the message. sequence_number: description: Sequence number of this packet in the session. format: int32 type: integer version: description: The version. This scanner supports version 6. format: int32 type: integer type: object Ipmi_RMCPHeader_MessageClass: additionalProperties: false properties: class: description: Just the class part of the byte (lower 5 bits of raw) format: int32 type: integer is_ack: description: True if the message is an acknowledgment to a previous message. type: boolean name: description: The human-readable name of the message class type: string raw: description: The raw message class byte. format: int32 type: integer type: object Ipmi_SessionHeader: additionalProperties: false properties: auth_code: description: The 16-byte authentication code; not present if auth_type is None. format: hex type: string auth_type: $ref: "#/components/schemas/Ipmi_SessionHeader_AuthType" description: The authentication type for this request (see section 13.6) session_id: description: The ID of this sessiod. format: int64 type: integer session_sequence_number: description: The session sequence number of this packet in the session format: int64 type: integer type: object Ipmi_SessionHeader_AuthType: additionalProperties: false properties: name: description: The raw value of the auth_type type: string raw: description: The raw value of the auth_type format: int32 type: integer type: description: Just the auth type (reserved bits omitted) format: int32 type: integer type: object Ipp: additionalProperties: false properties: attribute_cups_version: description: The CUPS version, if any, specified in the list of attributes returned in a get-printer-attributes response or CUPS-get-printers response. Generally in the form 'x.y.z'. type: string attribute_ipp_versions: description: Each IPP version, if any, specified in the list of attributes returned in a get-printer-attributes response or CUPS-get-printers response. Always in the form 'x.y'. items: type: string type: - array - "null" attribute_printer_uris: description: Each printer URI, if any, specified in the list of attributes returned in a get-printer-attributes response or CUPS-get-printers response. Uses ipp(s) or http(s) scheme, followed by a hostname or IP, and then the path to a particular printer. items: type: string type: - array - "null" attributes: description: All IPP attributes included in any contentful responses obtained. Each has a name, list of values (potentially only one), and a tag denoting how the value should be interpreted. items: $ref: "#/components/schemas/Ipp_Attribute" type: - array - "null" cups_version: description: The CUPS version, if any, specified in the Server header of an IPP get-attributes response. type: string major_version: description: Major component of IPP version listed in the Server header of a response to an IPP get-printer-attributes request. format: int32 minimum: 0 type: integer minor_version: description: Minor component of IPP version listed in the Server header of a response to an IPP get-printer-attributes request. format: int32 minimum: 0 type: integer version_string: description: The specific IPP version returned in response to an IPP get-printer-attributes request. Always in the form 'IPP/x.y' type: string type: object Ipp_Attribute: additionalProperties: false properties: name: type: string value_tag: format: int32 minimum: 0 type: integer type: object Iscsi: additionalProperties: false properties: connection: $ref: "#/components/schemas/Connection" errors: items: type: string type: - array - "null" targets: items: $ref: "#/components/schemas/Target" type: - array - "null" type: object IvantiAvalanche: additionalProperties: false properties: body: format: utf8 type: string status_code: format: int32 type: integer version: type: string type: object JA4TScanScan: additionalProperties: false properties: fingerprint: type: string scan_time: type: string type: object JarmScan: additionalProperties: false properties: cipher_and_version_fingerprint: description: The first 30 character portion of the Jarm fingerprint. format: hex type: string fingerprint: description: The 62 character Jarm fingerprint of the service. format: hex type: string hostname: type: string ip: type: string is_success: type: boolean port: format: int32 minimum: 0 type: integer scan_time: description: The time the service was fingerprinted type: string tls_extensions_sha256: description: The second 32 character portion of the Jarm fingerprint format: hex type: string transport_protocol: enum: - "" - tcp - udp - icmp - quic type: string type: object JarmScanned: additionalProperties: false properties: diff: additionalProperties: $ref: "#/components/schemas/FieldDiff" type: object scan: $ref: "#/components/schemas/JarmScan" type: object Jenkins: additionalProperties: false properties: assigned_labels: items: $ref: "#/components/schemas/Jenkins_Label" type: - array - "null" jobs: items: $ref: "#/components/schemas/Jenkins_Job" type: - array - "null" mode: type: string node_description: type: string node_name: type: string slave_agent_port: format: int32 type: integer use_security: type: boolean type: object Jenkins_Build: additionalProperties: false properties: duration_seconds: format: int64 type: integer number: format: int64 type: integer result: type: string timestamp: format: int64 type: integer url: type: string type: object Jenkins_Job: additionalProperties: false properties: description: type: string last_build: $ref: "#/components/schemas/Jenkins_Build" name: type: string url: type: string type: object Jenkins_Label: additionalProperties: false properties: name: type: string value: type: string type: object KEV: additionalProperties: false properties: date_added: description: The date the vulnerability was added to the KEV catalog. type: string date_due: description: Per CISA’s Binding Operation Directive 22-01, the date all federal civilian executive branch (FCEB) agencies are required to remediate vulnerabilities in the KEV catalog. type: string source: description: The source checked to determine whether the CVE is in the KEV catalog. enum: - "" - cisa - third_party type: string type: object KeyAlgorithm: additionalProperties: false properties: name: description: Name of public key type, such as RSA or ECDSA. Information specific to the key type is available in the named sub-record. type: string oid: type: string type: object KeyUsage: additionalProperties: false properties: certificate_sign: description: Whether the keyCertSign bit is set. type: boolean content_commitment: description: Whether the contentCommitment (formerly called nonRepudiation) bit is set. type: boolean crl_sign: description: Whether the cRLSign bit is set. type: boolean data_encipherment: description: Whether the dataEncipherment bit is set. type: boolean decipher_only: description: Whether the decipherOnly bit is set. type: boolean digital_signature: description: Whether the digitalSignature bit is set. type: boolean encipher_only: description: Whether the encipherOnly bit is set. type: boolean key_agreement: description: Whether the keyAgreement bit is set. type: boolean key_encipherment: description: Whether the keyEncipherment bit is set. type: boolean value: description: The integer value of the bitmask in the extension. format: int32 minimum: 0 type: integer type: object Krpc: additionalProperties: false properties: ping_response_id: type: string type: object Kubernetes: additionalProperties: false properties: endpoints: items: $ref: "#/components/schemas/Kubernetes_Endpoint" type: - array - "null" kubernetes_dashboard_found: description: True if the dashboard is running and accessible type: boolean nodes: items: $ref: "#/components/schemas/Kubernetes_Node" type: - array - "null" pod_names: items: type: string type: - array - "null" roles: items: $ref: "#/components/schemas/Kubernetes_Role" type: - array - "null" version_info: $ref: "#/components/schemas/Kubernetes_VersionInfo" type: object Kubernetes_Endpoint: additionalProperties: false properties: name: type: string self_link: type: string subsets: items: $ref: "#/components/schemas/Kubernetes_Endpoint_Subset" type: - array - "null" type: object Kubernetes_Endpoint_Subset: additionalProperties: false properties: addresses: items: $ref: "#/components/schemas/Kubernetes_Endpoint_Subset_EndpointAddress" type: - array - "null" ports: items: $ref: "#/components/schemas/Kubernetes_Endpoint_Subset_Port" type: - array - "null" type: object Kubernetes_Endpoint_Subset_EndpointAddress: additionalProperties: false properties: hostname: type: string ip: type: string node_name: type: string type: object Kubernetes_Endpoint_Subset_Port: additionalProperties: false properties: name: type: string port: format: int32 minimum: 0 type: integer protocol: type: string type: object Kubernetes_Node: additionalProperties: false properties: addresses: items: $ref: "#/components/schemas/Kubernetes_Node_NodeAddress" type: - array - "null" architecture: description: The Architecture reported by the node. type: string container_runtime_version: description: ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). type: string images: description: List of container images on this node items: type: string type: - array - "null" kernel_version: description: Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). type: string kube_proxy_version: description: KubeProxy Version reported by the node. type: string kubelet_version: description: Kubelet Version reported by the node. type: string name: type: string operating_system: description: The Operating System reported by the node. type: string os_image: description: OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). type: string type: object Kubernetes_Node_NodeAddress: additionalProperties: false properties: address: description: Node address, IP/URL. type: string address_type: description: Node address type, one of Hostname, ExternalIP or InternalIP. type: string type: object Kubernetes_Role: additionalProperties: false properties: name: type: string rules: description: Rules set for this role. items: $ref: "#/components/schemas/Kubernetes_Role_Rule" type: - array - "null" type: object Kubernetes_Role_Rule: additionalProperties: false properties: api_groups: description: APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. items: type: string type: - array - "null" resources: description: Resources is a list of resources this rule applies to. ResourceAll represents all resources items: type: string type: - array - "null" verbs: description: Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. items: type: string type: - array - "null" type: object Kubernetes_VersionInfo: additionalProperties: false properties: build_date: description: Date version was built. type: string compiler: description: Go Compiler used type: string git_commit: description: Git commit version built from. type: string git_tree_state: description: State of the tree when built. type: string git_version: type: string go_version: description: Version of GO used to build version. type: string major: description: Kubernetes major version type: string minor: description: Kubernetes minor version type: string platform: description: Platform compiled for type: string type: object L2Tp: additionalProperties: false properties: hello_received: type: boolean ordered_messages_raw: format: utf8 items: type: string type: - array - "null" sccn_received: type: boolean sccrp: $ref: "#/components/schemas/L2Tp_Sccrp" sccrp_received: type: boolean sccrq_received: type: boolean stop_sccn: $ref: "#/components/schemas/L2Tp_StopCcn" stop_sccn_received: type: boolean zlb_received: type: boolean type: object L2Tp_AttributeValues: additionalProperties: false properties: error_code: format: int32 minimum: 0 type: integer error_meaning: type: string error_message: type: string firmware_revision: format: int32 minimum: 0 type: integer hostname: type: string protocol_revision: format: int32 minimum: 0 type: integer protocol_version: format: int32 minimum: 0 type: integer result_code: format: int32 minimum: 0 type: integer result_meaning: type: string vendor_name: type: string window_size: format: int32 minimum: 0 type: integer type: object L2Tp_Sccrp: additionalProperties: false properties: attribute_values: $ref: "#/components/schemas/L2Tp_AttributeValues" type: object L2Tp_StopCcn: additionalProperties: false properties: attribute_values: $ref: "#/components/schemas/L2Tp_AttributeValues" type: object Label: additionalProperties: false properties: confidence: format: double type: number evidence: items: $ref: "#/components/schemas/Evidence" type: - array - "null" source: enum: - "" - censys - recog - wappalyzer - third_party - html_meta_extractor type: string value: type: string type: object Ldap: additionalProperties: false properties: allows_anonymous_bind: description: Ability to connect with anonymous bind (empty username and password) type: boolean attributes: description: All root DN attributes available via anonymous bind items: $ref: "#/components/schemas/Ldap_Attribute" type: - array - "null" result_code: description: Result or error code returned by LDAP instance upon bind format: int32 minimum: 0 type: integer type: object Ldap_Attribute: additionalProperties: false properties: name: description: Name of the LDAP attribute in the root DN type: string values: description: Values for the respective LDAP attribute format: utf8 items: type: string type: - array - "null" type: object ListCollectionsResponseV1: additionalProperties: false properties: collections: items: $ref: "#/components/schemas/Collection" type: - array - "null" next_page_token: type: string required: - collections - next_page_token type: object Location: additionalProperties: false properties: city: description: The English name of the detected city. type: string continent: description: The English name of the detected continent (North America, Europe, Asia, South America, Africa, Oceania, Antarctica). type: string coordinates: $ref: "#/components/schemas/Coordinates" description: The estimated coordinates of the detected location. country: description: The English name of the detected country. type: string country_code: description: The detected two-letter ISO 3166-1 alpha-2 country code (US, CN, GB, RU, ...). type: string postal_code: description: The postal code (if applicable) of the detected location. type: string province: description: The state or province name of the detected location. type: string registered_country: description: The English name of the registered country. type: string registered_country_code: description: The registered country's two-letter ISO 3166-1 alpha-2 country code (US, CN, GB, RU, ...). type: string timezone: description: The IANA time zone database name of the detected location. type: string type: object LocationUpdated: additionalProperties: false properties: location: $ref: "#/components/schemas/Location" type: object Lpd: additionalProperties: false properties: jobs: $ref: "#/components/schemas/LpdMessage" long_state: type: string lpd_message: $ref: "#/components/schemas/LpdMessage" printer: type: string raw: type: string short_state: type: string text: type: string type: object LpdMessage: additionalProperties: false properties: body: format: base64 type: string status: format: int32 minimum: 0 type: integer type: object MatchedService: additionalProperties: false properties: port: format: int32 minimum: 0 type: integer protocol: type: string transport_protocol: enum: - "" - tcp - udp - icmp - quic type: string type: object Mavlink: additionalProperties: false properties: frames: items: $ref: "#/components/schemas/Mavlink_Frame" type: - array - "null" saw_pong: type: boolean type: object Mavlink_Frame: additionalProperties: false properties: component_id: format: int32 minimum: 0 type: integer message_id: format: int32 minimum: 0 type: integer message_type: type: string payload: format: hex type: string system_id: format: int32 minimum: 0 type: integer version: format: int32 minimum: 0 type: integer type: object Mcp: additionalProperties: false properties: prompts: items: $ref: "#/components/schemas/McpPrompt" type: - array - "null" protocol_version: type: string resources: items: $ref: "#/components/schemas/McpResource" type: - array - "null" server_name: type: string server_version: type: string tools: items: $ref: "#/components/schemas/McpTool" type: - array - "null" type: object McpPrompt: additionalProperties: false properties: name: type: string type: object McpResource: additionalProperties: false properties: content: type: string description: type: string mime_type: type: string name: type: string uri: type: string type: object McpTool: additionalProperties: false properties: description: type: string name: type: string type: object Mdns: additionalProperties: false properties: multiple_responses: type: boolean names: items: type: string type: - array - "null" results: items: $ref: "#/components/schemas/MdnsResult" type: - array - "null" type: object MdnsResult: additionalProperties: false properties: addresses: items: type: string type: - array - "null" full_name: type: string port: format: int32 type: integer priority: format: int32 type: integer target: type: string texts: items: type: string type: - array - "null" weight: format: int32 type: integer type: object MediaCapabilities: additionalProperties: false properties: osd: type: boolean profile: $ref: "#/components/schemas/MediaProfile" rotation: type: boolean snapshot_uri: type: boolean streaming: $ref: "#/components/schemas/MediaStreaming" video_source_mode: type: boolean type: object MediaProfile: additionalProperties: false properties: max_profile_count: format: int32 minimum: 0 type: integer type: object MediaStreaming: additionalProperties: false properties: non_aggregate_control: type: boolean rtp_multicast: type: boolean rtp_rtsp_tcp: type: boolean rtp_tcp: type: boolean type: object Melsec: additionalProperties: false properties: cpu_info: type: string type: object MemberCounts: additionalProperties: false properties: by_role: description: The number of members users in the organization, split by role. properties: admin: description: The number of users with the admin role. format: int64 type: integer api_access: description: The number of users with the API access role. format: int64 type: integer type: object total: description: The total number of members users in the organization. format: int64 type: integer required: - total - by_role type: object Memberlist: additionalProperties: false properties: encrypted: type: boolean encrypted_len: format: int32 minimum: 0 type: integer encryption_version: format: int32 minimum: 0 type: integer error_message: type: string node: $ref: "#/components/schemas/Memberlist_NodeInfo" type: object Memberlist_NodeInfo: additionalProperties: false properties: delegate_versions: items: format: int32 minimum: 0 type: integer type: - array - "null" incarnation: format: int32 minimum: 0 type: integer ip: type: string meta: format: base64 type: string name: type: string port: format: int32 minimum: 0 type: integer protocol_version: format: int32 minimum: 0 type: integer type: object Members: additionalProperties: false properties: client_urls: items: type: string type: - array - "null" id: type: string name: type: string peer_urls: items: type: string type: - array - "null" type: object Memcached: additionalProperties: false properties: ascii_binding_protocol_enabled: description: Whether server responds to a handshake using the ASCII wire format of the protocol. type: boolean binary_binding_protocol_enabled: description: Whether server responds to a handshake using the binary wire format of the protocol. type: boolean responds_to_udp: description: Whether the server on the UDP port with the same number responds to a handshake using the ASCII wire format of the protocol. type: boolean stats: additionalProperties: type: string description: Server information returned in response to the stats command, as a set of key:value pairs. type: object version: description: The Memcached version indicated in the server's response. type: string type: object Metrics: additionalProperties: false properties: cvss_v30: $ref: "#/components/schemas/CVSS" cvss_v31: $ref: "#/components/schemas/CVSS" cvss_v40: $ref: "#/components/schemas/CVSSv4" epss: $ref: "#/components/schemas/EPSS" type: object MikrotikWinbox: additionalProperties: false properties: components: items: type: string type: - array - "null" version: type: string type: object Minecraft: additionalProperties: false properties: motd: type: string players_max: format: int64 type: integer players_online: format: int64 type: integer protocol_version: type: string server_version: type: string type: object Mms: additionalProperties: false properties: model: type: string revision: type: string vendor: type: string type: object Modbus: additionalProperties: false properties: exception_response: $ref: "#/components/schemas/Modbus_ExceptionResponse" function: format: int32 minimum: 0 type: integer mei_response: $ref: "#/components/schemas/Modbus_MEIResponse" unit_id: format: int64 type: integer type: object Modbus_ExceptionResponse: additionalProperties: false properties: exception_function: format: int32 minimum: 0 type: integer exception_type: format: int32 minimum: 0 type: integer type: object Modbus_MEIResponse: additionalProperties: false properties: conformity_level: format: int64 type: integer more_follows: type: boolean objects: additionalProperties: type: string type: object type: object MoneroP2P: additionalProperties: false properties: ping_response: $ref: "#/components/schemas/MoneroP2P_PingResponse" type: object MoneroP2P_Entry: additionalProperties: false properties: data: type: string name: type: string type: object MoneroP2P_Payload: additionalProperties: false properties: entries: items: $ref: "#/components/schemas/MoneroP2P_Entry" type: - array - "null" type: object MoneroP2P_PingResponse: additionalProperties: false properties: payload: $ref: "#/components/schemas/MoneroP2P_Payload" response_header: $ref: "#/components/schemas/MoneroP2P_ResponseHeader" type: object MoneroP2P_ResponseHeader: additionalProperties: false properties: command: format: int32 minimum: 0 type: integer expects_response: type: boolean flags: format: int32 minimum: 0 type: integer length: format: int32 minimum: 0 type: integer return_code: format: int32 type: integer signature: format: int64 minimum: 0 type: integer version: format: int32 minimum: 0 type: integer type: object Mongodb: additionalProperties: false properties: build_info: $ref: "#/components/schemas/Mongodb_BuildInfo" is_master: $ref: "#/components/schemas/Mongodb_IsMaster" type: object Mongodb_BuildInfo: additionalProperties: false properties: build_environment: $ref: "#/components/schemas/Mongodb_BuildInfo_BuildEnvironment" git_version: description: Version of mongodb server type: string version: description: Version of mongodb server type: string type: object Mongodb_BuildInfo_BuildEnvironment: additionalProperties: false properties: cc: type: string cc_flags: type: string cxx: type: string cxx_flags: type: string dist_arch: type: string dist_mod: type: string link_flags: type: string target_arch: type: string target_os: type: string type: object Mongodb_IsMaster: additionalProperties: false properties: is_master: type: boolean logical_session_timeout_minutes: format: int32 type: integer max_bson_object_size: format: int32 type: integer max_message_size_bytes: format: int32 type: integer max_wire_version: format: int32 type: integer max_write_batch_size: format: int32 type: integer min_wire_version: format: int32 type: integer read_only: type: boolean type: object Mqtt: additionalProperties: false properties: connection_ack_raw: description: Raw CONNACK response packet format: hex type: string connection_ack_return: $ref: "#/components/schemas/Mqtt_ConnectionAckReturn" subscription_ack_return: $ref: "#/components/schemas/Mqtt_SubscriptionAckReturn" type: object Mqtt_ConnectionAckReturn: additionalProperties: false properties: raw: description: Raw connect status value format: int32 minimum: 0 type: integer return_value: description: Connection status type: string type: object Mqtt_SubscriptionAckReturn: additionalProperties: false properties: raw: description: Raw subscription response value format: int32 minimum: 0 type: integer return_value: description: Subscription response type: string type: object Mssql: additionalProperties: false properties: encrypt_mode: description: The negotiated ENCRYPT_MODE with the server type: string instance_name: type: string prelogin_options: $ref: "#/components/schemas/Mssql_PreloginOptions" version: type: string type: object Mssql_PreloginOptions: additionalProperties: false properties: encrypt_mode: type: string fed_auth_required: type: boolean instance: type: string mars: type: boolean nonce: format: hex type: string server_version: $ref: "#/components/schemas/Mssql_PreloginOptions_ServerVersion" thread_id: format: int32 minimum: 0 type: integer trace_id: format: hex type: string unknown: additionalProperties: type: string format: hex type: object type: object Mssql_PreloginOptions_ServerVersion: additionalProperties: false properties: build_number: format: int32 minimum: 0 type: integer major: format: int32 minimum: 0 type: integer minor: format: int32 minimum: 0 type: integer type: object Murmur: additionalProperties: false properties: crypt_setup: $ref: "#/components/schemas/CryptSetup" murmur_messages: items: $ref: "#/components/schemas/MurmurMessage" type: - array - "null" reject: $ref: "#/components/schemas/Reject" server_config: $ref: "#/components/schemas/ServerConfig" server_sync: $ref: "#/components/schemas/ServerSync" text_messages: items: $ref: "#/components/schemas/TextMessage" type: - array - "null" version: $ref: "#/components/schemas/Murmur_MurmurVersion" type: object MurmurMessage: additionalProperties: false properties: body: format: base64 type: string header: $ref: "#/components/schemas/MurmurMessage_MurmurHeader" type: object MurmurMessage_MurmurHeader: additionalProperties: false properties: length: format: int32 minimum: 0 type: integer type: type: string type: object Murmur_MurmurVersion: additionalProperties: false properties: build: format: int32 minimum: 0 type: integer major: format: int32 minimum: 0 type: integer minor: format: int32 minimum: 0 type: integer os: type: string os_version: type: string version_string: type: string type: object Mysql: additionalProperties: false properties: auth_plugin_data: description: Optional plugin-specific data, whose meaning depends on the value of auth_plugin_name. Returned in the initial HandshakePacket. format: hex type: string auth_plugin_name: description: The name of the authentication plugin, returned in the initial HandshakePacket. type: string capability_flags: additionalProperties: type: boolean description: "The set of capability flags the server returned in the initial HandshakePacket. Each entry corresponds to a bit being set in the flags; key names correspond to the #defines in the MySQL docs." type: object character_set: description: The identifier for the character set the server is using. Returned in the initial HandshakePacket. format: int32 minimum: 0 type: integer connection_id: description: The server's internal identifier for this client's connection, sent in the initial HandshakePacket. format: int32 minimum: 0 type: integer error_code: description: Only set if there is an error returned by the server, for example if the scanner is not on the allowed hosts list. format: int64 type: integer error_id: description: The friendly name for the error code as defined at https://dev.mysql.com/doc/refman/8.0/en/error-messages-server.html, or UNKNOWN type: string error_message: description: Optional string describing the error. Only set if there is an error. type: string protocol_version: description: 8-bit unsigned integer representing the server's protocol version sent in the initial HandshakePacket from the server. format: int32 minimum: 0 type: integer server_version: description: The specific server version returned in the initial HandshakePacket. Often in the form x.y.z, but not always. type: string status_flags: additionalProperties: type: boolean description: "The set of status flags the server returned in the initial HandshakePacket. Each entry corresponds to a bit being set in the flags; key names correspond to the #defines in the MySQL docs." type: object type: object NameConstraints: additionalProperties: false properties: critical: type: boolean excluded_directory_names: description: A record providing excluded names of the type directoryName in leaf certificates whose trust path includes this certificate. items: $ref: "#/components/schemas/DistinguishedName" type: - array - "null" excluded_edi_party_names: description: A record providing excluded names of the type ediPartyName in leaf certificates whose trust path includes this certificate. items: $ref: "#/components/schemas/EdiPartyName" type: - array - "null" excluded_email_addresses: description: A record providing a range of excluded names of the type rfc822Name in leaf certificates whose trust path includes this certificate. items: type: string type: - array - "null" excluded_ip_addresses: description: A record providing a range of excluded names of the type iPAddress in leaf certificates whose trust path includes this certificate. items: $ref: "#/components/schemas/GeneralSubtreeIp" type: - array - "null" excluded_names: description: A record providing a range of excluded names of the type dNSName in leaf certificates whose trust path includes this certificate. items: type: string type: - array - "null" excluded_registered_ids: description: A record providing excluded names of the type registeredID in leaf certificates whose trust path includes this certificate. items: type: string type: - array - "null" excluded_uris: description: A record providing a range of excluded uniform resource identifiers in leaf certificates whose trust path includes this certificate. items: type: string type: - array - "null" permitted_directory_names: description: A record providing permitted names of the type directoryName in leaf certificates whose trust path includes this certificate. items: $ref: "#/components/schemas/DistinguishedName" type: - array - "null" permitted_edi_party_names: description: A record providing permitted names of the type ediPartyName in leaf certificates whose trust path includes this certificate. items: $ref: "#/components/schemas/EdiPartyName" type: - array - "null" permitted_email_addresses: description: A record providing a range of permitted names of the type rfc822Name in leaf certificates whose trust path includes this certificate. items: type: string type: - array - "null" permitted_ip_addresses: description: A record providing a range of permitted names of the type iPAddress in leaf certificates whose trust path includes this certificate. items: $ref: "#/components/schemas/GeneralSubtreeIp" type: - array - "null" permitted_names: description: A record providing a range of permitted names of the type dNSName in leaf certificates whose trust path includes this certificate. items: type: string type: - array - "null" permitted_registered_ids: description: A record providing permitted names of the type registeredID in leaf certificates whose trust path includes this certificate. items: type: string type: - array - "null" permitted_uris: description: A record providing a range of permitted uniform resource identifiers in leaf certificates whose trust path includes this certificate. items: type: string type: - array - "null" type: object NatsIo: additionalProperties: false properties: auth_required: type: boolean cluster: type: string connect_urls: items: type: string type: - array - "null" domain: type: string git_commit: type: string go: type: string headers: type: boolean jetstream: type: boolean proto: format: int32 type: integer server_id: type: string server_name: type: string tls_available: type: boolean tls_required: type: boolean tls_verify: type: boolean version: type: string ws_connect_urls: items: type: string type: - array - "null" type: object Nbd: additionalProperties: false properties: exports: items: $ref: "#/components/schemas/Export" type: - array - "null" handshake_style: type: string policies: items: type: string type: - array - "null" type: object Network: additionalProperties: false properties: allocation_type: type: string cidrs: description: A set of CIDRs describing the range. items: type: string type: - array - "null" created: type: string handle: type: string name: type: string updated: type: string type: object NetworkCapabilities: additionalProperties: false properties: dhcp_v6: type: boolean dot11_configuration: type: boolean dot1x_configurations: format: int32 minimum: 0 type: integer dynamic_dns: type: boolean hostname_from_dhcp: type: boolean ip_filter: type: boolean ipv6: type: boolean ntp: format: int32 minimum: 0 type: integer zero_configuration: type: boolean type: object NetworkClassification: additionalProperties: false properties: hosting: description: Whether the host belongs to an Internet hosting service provider. type: boolean mobile: description: Whether the host belongs to a mobile network. type: boolean mobile_info: $ref: "#/components/schemas/Network_MobileInfo" description: Information about the mobile network the host belongs to, if any. satellite: description: Whether the host belongs to a statellite network. type: boolean source: description: The source of the data. type: string type: object NetworkLog: additionalProperties: false properties: har_handle: description: Storage handle for the full HAR network log. type: string resources: description: Resources fetched during page load. items: $ref: "#/components/schemas/NetworkLog_ResourceInfo" type: - array - "null" type: object NetworkLog_ResourceInfo: additionalProperties: false properties: host: description: Hostname from the URL. type: string md5: description: MD5 hash of the resource content. format: hex type: string mime_type: description: MIME type of the resource. type: string path: description: Path from the URL. type: string port: description: Port from the URL. type: string scheme: description: URL scheme (e.g., http, https). type: string sha1: description: SHA-1 hash of the resource content. format: hex type: string sha256: description: SHA-256 hash of the resource content. format: hex type: string size: description: Size of the resource in bytes. format: int32 type: integer url: description: Full URL of the resource. type: string type: object Network_MobileInfo: additionalProperties: false properties: carrier_name: description: The name of the mobile carrier. type: string mcc: description: The Mobile Country Code, identifying the country of the mobile network. type: string mnc: description: The Mobile Network Code, identifying the specific carrier network. type: string type: object NfsMountd: additionalProperties: false properties: export_lists: items: $ref: "#/components/schemas/ExportList" type: - array - "null" type: object Nmea: additionalProperties: false properties: messages: items: $ref: "#/components/schemas/Nmea_NmeaMessage" type: - array - "null" type: object Nmea_NmeaMessage: additionalProperties: false properties: fields: items: type: string type: - array - "null" sentence_id: type: string talker_id: type: string talker_name: type: string type: object NodeInfoV0: additionalProperties: false properties: features: items: type: string type: - array - "null" is_healthy: type: boolean latest_milestone: format: int64 type: integer latest_uncommitted_milestone: format: int64 type: integer name: type: string neighbors: format: int64 type: integer tips: format: int64 type: integer version: type: string type: object NodeInfoV1: additionalProperties: false properties: confirmed_milestone_index: format: int64 type: integer features: items: type: string type: - array - "null" is_healthy: type: boolean latest_milestone_index: format: int64 type: integer name: type: string network_id: type: string version: type: string type: object NodeInfoV2: additionalProperties: false properties: decimals: format: int64 type: integer features: items: type: string type: - array - "null" is_healthy: type: boolean latest_milestone: format: int64 type: integer latest_uncommitted_milestone: format: int64 type: integer name: type: string network_name: type: string protocol_version: format: int64 type: integer subunit: type: string supported_protocol_versions: items: format: int64 type: integer type: - array - "null" ticker_symbol: type: string token_name: type: string token_supply: type: string unit: type: string version: type: string type: object NoticeReference: additionalProperties: false properties: notice_numbers: items: format: int32 type: integer type: - array - "null" organization: type: string type: object NtlmInfo: additionalProperties: false properties: always_sign_supported: type: boolean challenge_type: format: int32 type: integer dns_domain_name: type: string dns_server_name: type: string dns_tree_name: type: string encryption_128bit_supported: type: boolean encryption_56bit_supported: type: boolean netbios_computer_name: type: string netbios_domain_name: type: string ntlm1_supported: type: boolean ntlm2_supported: type: boolean ntlm_version: format: int32 minimum: 0 type: integer os_version: type: string target_name: type: string type: object Ntp: additionalProperties: false properties: get_time_header: $ref: "#/components/schemas/Ntp_NTPHeader" description: The header of the server's response to a GetTime request. type: object Ntp_NTPHeader: additionalProperties: false properties: leap_indicator: description: An enumerated value from 0 to 3 signifying whether a leap second will occur at the end of the current month. 0 signifies no leap second, 1 signifies an additive leap second, 2 signifies a subtractive leap second, and 3 signifies the state is unknown. format: int32 minimum: 0 type: integer mode: description: An enumerated value from 0 to 7 signifying the operational mode of the server. format: int32 minimum: 0 type: integer poll: description: The interval within which the server will expect a subsequent synchronization message, in log2 seconds. format: int32 type: integer precision: description: The precision of the system's clock, in log2 seconds. format: int32 type: integer reference_id: description: The identifier of the reference clock. For servers in stratum 1, one of an IANA-maintained list of sources. For servers in stratum 2, the ID of the stratum 1 server from which the time was retrieved (usually, its IP address), etc. format: hex type: string stratum: description: The number of servers between a client and a non-NTP time source. 1 signifies that the server is authoritative, having direct access to a sensor. 2 signifies that the server got its time from a "stratum 1" server, etc. 16 means the clock is unsynchronized. format: int32 minimum: 0 type: integer version: description: The NTP version indicated in the server's response. format: int32 minimum: 0 type: integer type: object Ntrip: additionalProperties: false properties: data_streams: items: $ref: "#/components/schemas/Ntrip_DataStream" type: - array - "null" server: type: string version: type: string type: object Ntrip_DataStream: additionalProperties: false properties: authentication: items: type: string type: - array - "null" bitrate: format: int32 minimum: 0 type: integer carrier_info: type: string caster_mount_point: type: string compression_or_encryption: type: string country_code: type: string data_format: type: string fee: type: boolean format_details: type: string generator: type: string latitude: type: string longitude: type: string misc: type: string nav_system: type: string network: type: string nmea: type: boolean solution: type: string source_identifier: type: string type: object Ollama: additionalProperties: false properties: models: items: $ref: "#/components/schemas/Ollama_Model" type: - array - "null" running_models: items: $ref: "#/components/schemas/Ollama_Model" type: - array - "null" version: type: string type: object Ollama_Model: additionalProperties: false properties: digest: type: string expires_at: type: string family: type: string model: type: string name: type: string parent_model: type: string size: format: int64 minimum: 0 type: integer size_vram: format: int64 minimum: 0 type: integer type: object Onc: additionalProperties: false type: object Onvif: additionalProperties: false properties: hostname: $ref: "#/components/schemas/Onvif_Hostname" services: items: $ref: "#/components/schemas/OnvifService" type: - array - "null" type: object OnvifService: additionalProperties: false properties: capabilities: $ref: "#/components/schemas/Capabilities" namespace: type: string service_version_major: format: int32 minimum: 0 type: integer service_version_minor: format: int32 minimum: 0 type: integer xaddr: type: string type: object Onvif_Hostname: additionalProperties: false properties: from_dhcp: type: boolean name: type: string type: object OpcUa: additionalProperties: false properties: endpoints: items: $ref: "#/components/schemas/OpcUa_Endpoint" type: - array - "null" max_chunk_size: format: int32 minimum: 0 type: integer max_message_size: format: int32 minimum: 0 type: integer protocol_version: format: int32 minimum: 0 type: integer receive_buffer_size: format: int32 minimum: 0 type: integer send_buffer_size: format: int32 minimum: 0 type: integer type: object OpcUa_Description: additionalProperties: false properties: application_name: $ref: "#/components/schemas/OpcUa_LocalizedText" application_type: format: int32 minimum: 0 type: integer application_uri: type: string discovery_profile_uri: type: string discovery_urls: items: type: string type: - array - "null" gateway_server_uri: type: string product_uri: type: string type: object OpcUa_Endpoint: additionalProperties: false properties: endpoint_url: type: string security_level: format: int32 minimum: 0 type: integer security_mode: format: int32 minimum: 0 type: integer security_policy_uri: type: string serve_cert: format: base64 type: string server: $ref: "#/components/schemas/OpcUa_Description" transport_profile_uri: type: string user_identity_token: items: $ref: "#/components/schemas/OpcUa_UserTokenPolicy" type: - array - "null" type: object OpcUa_LocalizedText: additionalProperties: false properties: flags: format: int32 minimum: 0 type: integer locale: type: string text: type: string type: object OpcUa_UserTokenPolicy: additionalProperties: false properties: issued_token_type: type: string issuer_endpoint_url: type: string policy_id: type: string security_policy_uri: type: string token_type: format: int32 type: integer type: object OpenDirectory: additionalProperties: false properties: files: items: $ref: "#/components/schemas/OpenDirectory_File" type: - array - "null" recursive: type: boolean type: object OpenDirectory_File: additionalProperties: false properties: extension: type: string last_modified: type: string name: type: string path: type: string size: format: int64 type: integer suspicious_score: format: double type: number type: type: string type: object Openvpn: additionalProperties: false properties: accepts_v1: type: boolean accepts_v2: type: boolean type: object OpenvpnMgmt: additionalProperties: false properties: build_date: type: string features: items: type: string type: - array - "null" management_version: type: string open_vpn_version: type: string target_triple: type: string type: object Oracle: additionalProperties: false properties: accept_version: description: The version declared by the service when it accepts the handshake, if applicable. format: int32 minimum: 0 type: integer connect_flags0: additionalProperties: type: boolean description: The first set of ConnectFlags returned in the Accept packet. type: object connect_flags1: additionalProperties: type: boolean description: The second set of ConnectFlags returned in the Accept packet. type: object did_resend: description: Whether the server requested that the scanner resend its initial connection packet. type: boolean global_service_options: additionalProperties: type: boolean description: Set of flags that the server returns in the Accept packet. type: object nsn_service_versions: additionalProperties: type: string description: A map from the native Service Negotation service names to the ReleaseVersion (in dotted-decimal format) in that service packet. type: object nsn_version: description: The version string in the root of the native service negotiation packet, if applicable. type: string refuse_error: description: The parsed descriptor returned by the server in the Refuse packet; it is empty if the server does not return a Refuse packet. The keys are strings like 'DESCRIPTION.ERROR_STACK.ERROR.CODE items: $ref: "#/components/schemas/Oracle_Descriptor" type: - array - "null" refuse_error_raw: description: The unparsed error received when the initial handshake is refused. type: string refuse_reason_app: description: The 'AppReason' returned by the server in the RefusePacket, as an 8-bit unsigned hex string. type: string refuse_reason_sys: description: The 'SysReason' returned by the server in the RefusePacket, as an 8-bit unsigned hex string. type: string refuse_version: description: The version declared by the service when it refuses the handshake, if applicable. type: string type: object Oracle_Descriptor: additionalProperties: false properties: key: description: The dot-delimited path to the parsed value from the error received when the initial handshake is refused. type: string value: description: The parsed value from the error received when the initial handshake is refused. type: string type: object Organization: additionalProperties: false properties: abuse_contacts: items: $ref: "#/components/schemas/Contact" type: - array - "null" address: type: string admin_contacts: items: $ref: "#/components/schemas/Contact" type: - array - "null" city: type: string country: type: string handle: type: string name: type: string postal_code: type: string state: type: string street: type: string tech_contacts: items: $ref: "#/components/schemas/Contact" type: - array - "null" type: object OrganizationCredits: additionalProperties: false properties: auto_replenish_config: $ref: "#/components/schemas/AutoReplenishConfig" description: The auto-replenish configuration for the organization. balance: description: The current credit balance for the organization. format: int64 type: integer credit_expirations: description: The credit expirations for the organization. items: $ref: "#/components/schemas/CreditExpiration" type: - array - "null" uid: description: The ID of a Censys organization. format: uuid type: string required: - balance - auto_replenish_config - credit_expirations - uid type: object OrganizationDetails: additionalProperties: false properties: created_at: description: The date and time the organization was created. format: date-time type: string member_counts: $ref: "#/components/schemas/MemberCounts" description: The number of members in the organization, split by role. name: description: The name of the organization. type: string preferences: $ref: "#/components/schemas/OrganizationPreferences" description: The configured preferences of the organization. uid: description: The ID of a Censys organization. format: uuid type: string required: - name - uid type: object OrganizationMember: additionalProperties: false properties: created_at: description: The date and time the user was created. format: date-time type: string email: description: The email of the user. type: string first_login_time: description: The date and time the user first logged in. format: date-time type: string first_name: description: The first name of the user. type: string last_name: description: The last name of the user. type: string latest_login_time: description: The date and time the user last logged in. format: date-time type: string roles: description: The roles this member has in the organization. items: type: string type: - array - "null" uid: description: The ID of a Censys user. format: uuid type: string required: - roles - email - first_name - last_name - uid type: object OrganizationMembersList: additionalProperties: false properties: members: description: The list of members in the organization. items: $ref: "#/components/schemas/OrganizationMember" type: - array - "null" pagination: $ref: "#/components/schemas/PaginationInfo" description: Pagination information for listing more members. required: - members - pagination type: object OrganizationPreferences: additionalProperties: false properties: ai_opt_in: description: Whether the organization has opted into AI features. type: boolean ai_training: description: Whether the organization has opted into AI training. type: boolean mfa_required: description: Whether the organization has opted into multi-factor authentication. type: boolean type: object OtherName: additionalProperties: false properties: id: description: The OID identifying the syntax of the otherName value. type: string value: description: The raw otherName value. format: base64 type: string type: object PaginationInfo: additionalProperties: false properties: next_page_token: description: The token to use to retrieve the next page of results. type: string page_size: description: The number of results requested per page. format: int32 type: integer required: - page_size type: object PanTiltZoomCapabilities: additionalProperties: false properties: eflip: type: boolean get_compatible_configurations: type: boolean move_status: type: boolean reverse: type: boolean status_position: type: boolean type: object PcAnywhere: additionalProperties: false properties: name: description: Workstation Name, with padding bytes removed type: string nr: description: Full 'NR' query response type: string status: $ref: "#/components/schemas/PcAnywhere_Status" type: object PcAnywhere_Status: additionalProperties: false properties: in_use: description: Workstation is In Use if true, Available if false type: boolean raw: description: Full 'ST' query response format: hex type: string type: object Peer: additionalProperties: false properties: ip: type: string port: format: int64 type: integer public_key: type: string type: type: string version: type: string type: object Pgbouncer: additionalProperties: false properties: startup_capabilities: $ref: "#/components/schemas/Pgbouncer_StartupCapabilities" type: object Pgbouncer_StartupCapabilities: additionalProperties: false properties: v2: type: boolean v3: type: boolean v4: type: boolean type: object PixelFormat: additionalProperties: false properties: big_endian: description: If pixel RGB data are in big-endian type: boolean bits_per_pixel: description: "How many bits in a single full pixel datum. Valid values are: 8, 16, 32" format: int32 minimum: 0 type: integer blue_max: description: Max value of blue pixel format: int32 minimum: 0 type: integer blue_shift: description: How many bits to right shift a pixel datum to get blue bits in lsb format: int32 minimum: 0 type: integer depth: description: Color depth format: int32 minimum: 0 type: integer green_max: description: Max value of green pixel format: int32 minimum: 0 type: integer green_shift: description: How many bits to right shift a pixel datum to get green bits in lsb format: int32 minimum: 0 type: integer padding1: format: int32 minimum: 0 type: integer padding2: format: int32 minimum: 0 type: integer padding3: format: int32 minimum: 0 type: integer red_max: description: Max value of red pixel format: int32 minimum: 0 type: integer red_shift: description: How many bits to right shift a pixel datum to get red bits in lsb format: int32 minimum: 0 type: integer true_color: description: If false, color maps are used type: boolean type: object PlexMediaServer: additionalProperties: false properties: version: type: string type: object Pop3: additionalProperties: false properties: start_tls: description: The server's response to the STARTTLS command. format: utf8 type: string type: object Port: additionalProperties: false properties: port: type: string protocol: items: type: string type: - array - "null" type: object Portmap: additionalProperties: false properties: v2_entries: items: $ref: "#/components/schemas/Portmap_V2Entry" type: - array - "null" v3_entries: items: $ref: "#/components/schemas/Portmap_V3Entry" type: - array - "null" type: object Portmap_V2Entry: additionalProperties: false properties: description: type: string port: format: int32 minimum: 0 type: integer protocol: type: string shorthand: type: string version: format: int32 minimum: 0 type: integer type: object Portmap_V3Entry: additionalProperties: false properties: description: type: string network_id: type: string owner: type: string shorthand: type: string universal_address: type: string version: format: int32 minimum: 0 type: integer type: object Postgres: additionalProperties: false properties: protocol_error: additionalProperties: type: string description: The error received in response to a StartupMessage with an unexpected protocol version. type: object startup_error: additionalProperties: type: string description: The error received in response to a StartupMessage without providing the User field. type: object supported_versions: type: string type: object Pprof: additionalProperties: false properties: allocs: format: int32 type: integer block: format: int32 type: integer cmdline: type: string goroutine: format: int32 type: integer heap: format: int32 type: integer mutex: format: int32 type: integer profile: format: int32 type: integer threadcreate: format: int32 type: integer trace: format: int32 type: integer type: object Pptp: additionalProperties: false properties: bearer_message: $ref: "#/components/schemas/Pptp_ResponseInfo" error_message: $ref: "#/components/schemas/Pptp_ResponseInfo" firmware: $ref: "#/components/schemas/Pptp_Version" framing_message: $ref: "#/components/schemas/Pptp_ResponseInfo" hostname: type: string maximum_channels: format: int32 minimum: 0 type: integer protocol: $ref: "#/components/schemas/Pptp_Version" result_message: $ref: "#/components/schemas/Pptp_ResponseInfo" vendor: type: string type: object Pptp_ResponseInfo: additionalProperties: false properties: code: format: int32 minimum: 0 type: integer meaning: type: string type: object Pptp_Version: additionalProperties: false properties: major: format: int32 minimum: 0 type: integer minor: format: int32 minimum: 0 type: integer type: object Privacy: additionalProperties: false properties: anonymous: description: Whether the host uses any kind of privacy service. type: boolean proxy: description: Whether the host is an open web proxy. type: boolean relay: description: Whether the host is a location-preserving anonymous relay service, like iCloud Private Relay.. type: boolean service_provider: description: The name of the privacy service providers detected. items: type: string type: - array - "null" source: description: The source of the data. type: string tor: description: Whether the host is a Tor exit node. type: boolean tor_info: $ref: "#/components/schemas/Privacy_TorInfo" description: Information about the Tor exit node, if the host is one. vpn: description: Whether the host is a VPN service exit node IP address. type: boolean type: object Privacy_TorInfo: additionalProperties: false properties: relays: items: $ref: "#/components/schemas/Privacy_TorInfo_Relay" type: - array - "null" type: object Privacy_TorInfo_Relay: additionalProperties: false properties: advertised_bandwidth: description: Bandwidth in bytes per second that this relay is willing and capable to provide. The minimum of bandwidth_rate, bandwidth_burst, and observed_bandwidth. format: int64 type: integer alleged_family: description: Fingerprints of relays that are part of this relay's family but do not consider this relay to be part of their family. items: type: string type: - array - "null" bandwidth_burst: description: Bandwidth in bytes per second that this relay is willing to sustain in very short intervals. format: int64 type: integer bandwidth_rate: description: Average bandwidth in bytes per second that this relay is willing to sustain over long periods. format: int64 type: integer blocklist: description: Country codes where this bridge is not served because it is believed to be blocked. items: type: string type: - array - "null" bridge: description: Whether this entry represents a bridge rather than a relay. type: boolean bridgedb_distributor: description: BridgeDB distributor that this bridge is currently assigned to. type: string consensus_weight: description: Weight assigned to this relay by the directory authorities that clients use in their path selection algorithm. format: int64 type: integer consensus_weight_fraction: description: Fraction of this relay's consensus weight compared to the sum of all consensus weights in the network. A rough approximation of the probability of this relay to be selected by clients. format: double type: number contact: description: Contact address of the relay operator. type: string dir_address: description: IPv4 address and TCP port where the relay accepts directory connections. type: string effective_family: description: Fingerprints of relays in an effective, mutual family relationship with this relay. Always contains the relay's own fingerprint. items: type: string type: - array - "null" exit_addresses: description: IPv4 addresses that the relay used to exit to the Internet in the past 24 hours. items: type: string type: - array - "null" exit_policy: description: Array of exit-policy lines from the relay's router descriptor. items: type: string type: - array - "null" exit_policy_summary: $ref: "#/components/schemas/Privacy_TorInfo_Relay_ExitPolicySummary" description: Summary of the relay's exit policy containing accepted or rejected TCP ports/port ranges for most IP addresses. exit_policy_v6_summary: $ref: "#/components/schemas/Privacy_TorInfo_Relay_ExitPolicySummary" description: Summary of the relay's IPv6 exit policy containing accepted or rejected TCP ports/port ranges for most IP addresses. exit_probability: description: Probability of this relay to be selected for the exit position, calculated based on consensus weights, relay flags, and bandwidth weights. format: double type: number fingerprint: description: Relay fingerprint consisting of 40 upper-case hexadecimal characters. type: string flags: description: Relay flags assigned by the directory authorities. items: type: string type: - array - "null" guard_probability: description: Probability of this relay to be selected for the guard position, calculated based on consensus weights, relay flags, and bandwidth weights. format: double type: number hashed_fingerprint: description: SHA-1 hash of the bridge fingerprint consisting of 40 upper-case hexadecimal characters. type: string indirect_family: description: Fingerprints of relays reachable by following effective, mutual family relationships starting at this relay, but not directly in a mutual family relationship. items: type: string type: - array - "null" measured: description: Whether the consensus weight of this relay is based on a threshold of 3 or more measurements by Tor bandwidth authorities. type: boolean middle_probability: description: Probability of this relay to be selected for the middle position, calculated based on consensus weights, relay flags, and bandwidth weights. format: double type: number nickname: description: Relay nickname consisting of 1-19 alphanumerical characters. type: string observed_bandwidth: description: Bandwidth estimate in bytes per second of the capacity this relay can handle. The lesser of the maximum sustained output and input over any ten second period in the past day. format: int64 type: integer or_addresses: description: IPv4 or IPv6 addresses and TCP ports where the relay accepts onion-routing connections. The first address is the primary onion-routing address. items: type: string type: - array - "null" overload_general_timestamp: description: Timestamp indicating when the relay reached an overloaded state (e.g., OOM invocation, ntor onionskins dropped, or TCP port exhaustion). format: int64 type: integer platform: description: Platform string containing operating system and Tor version details. type: string recommended_version: description: Whether the Tor software version of this relay is recommended by the directory authorities. type: boolean transports: description: Pluggable transport names supported by this bridge. items: type: string type: - array - "null" unreachable_or_addresses: description: IPv4 or IPv6 addresses and TCP ports where the relay claims to accept onion-routing connections but that the directory authorities failed to confirm as reachable. items: type: string type: - array - "null" version: description: Tor software version without leading 'Tor' as reported by the directory authorities. type: string version_status: description: "Status of the Tor software version: recommended, experimental, obsolete, new in series, or unrecommended." type: string type: object Privacy_TorInfo_Relay_ExitPolicySummary: additionalProperties: false properties: accept: description: TCP ports or port ranges that the relay accepts for most IP addresses. items: type: string type: - array - "null" reject: description: TCP ports or port ranges that the relay rejects for most IP addresses. items: type: string type: - array - "null" type: object ProfinetCm: additionalProperties: false properties: byte_order: type: string lookup_response_raw: format: hex type: string multiple_fragments: type: boolean type: object Prometheus: additionalProperties: false properties: response: $ref: "#/components/schemas/Prometheus_Response" description: Information Prometheus captured as well as build information. type: object PrometheusMetricFamily: additionalProperties: false properties: help: type: string name: type: string type: object PrometheusTarget: additionalProperties: false properties: metric_families: items: $ref: "#/components/schemas/PrometheusMetricFamily" type: - array - "null" type: object Prometheus_Response: additionalProperties: false properties: active_targets: description: List of active targets. items: $ref: "#/components/schemas/Prometheus_Response_ActiveTarget" type: - array - "null" all_versions: description: List of the versions of everything that Prometheus finds i.e., version of Prometheus, Go, Node, cAdvisor, etc. items: type: string type: - array - "null" config_exposed: description: True when the config endpoint is exposed. type: boolean dropped_targets: description: List of dropped targets. items: $ref: "#/components/schemas/Prometheus_Response_DroppedTarget" type: - array - "null" go_versions: description: List of the versions of Go. items: type: string type: - array - "null" prometheus_versions: items: $ref: "#/components/schemas/Prometheus_Response_PrometheusVersion" type: - array - "null" type: object Prometheus_Response_ActiveTarget: additionalProperties: false properties: discovered_labels: $ref: "#/components/schemas/Prometheus_Response_ActiveTarget_DiscoveredLabels" health: description: Whether target is up or down. type: string labels: $ref: "#/components/schemas/Prometheus_Response_ActiveTarget_Labels" last_error: description: Last error that occurred within target. type: string last_scrape: description: Last time Prometheus scraped target. type: string scrape_url: description: URL that Prometheus scraped. type: string type: object Prometheus_Response_ActiveTarget_DiscoveredLabels: additionalProperties: false properties: address: description: Address of target. type: string job: description: Job of target. type: string metrics_path: description: Path to metrics of target. type: string scheme: description: URL scheme. type: string type: object Prometheus_Response_ActiveTarget_Labels: additionalProperties: false properties: instance: description: Instance after relabelling has occurred. type: string job: description: Job of target after relabelling has occurred. type: string type: object Prometheus_Response_DroppedTarget: additionalProperties: false properties: address: description: Address of target. type: string job: description: Job of target. type: string metrics_path: description: Path to metrics of target. type: string scheme: description: URL scheme. type: string type: object Prometheus_Response_PrometheusVersion: additionalProperties: false properties: go_version: description: Version of Go used to build Prometheus. type: string revision: description: Revision of Prometheus. type: string version: description: Version of Prometheus. type: string type: object QcStatements: additionalProperties: false properties: ids: items: type: string type: - array - "null" parsed: $ref: "#/components/schemas/QcStatements_ParsedStatements" type: object QcStatements_MonetaryValue: additionalProperties: false properties: amount: format: int64 type: integer currency: type: string currency_number: format: int64 type: integer exponent: format: int64 type: integer type: object QcStatements_ParsedStatements: additionalProperties: false properties: etsi_compliance: items: type: boolean type: - array - "null" legislation: items: $ref: "#/components/schemas/QcStatements_QCLegislation" type: - array - "null" limit: items: $ref: "#/components/schemas/QcStatements_MonetaryValue" type: - array - "null" pds_locations: items: $ref: "#/components/schemas/QcStatements_PdsLocation" type: - array - "null" retention_period: items: format: int64 type: integer type: - array - "null" sscd: items: type: boolean type: - array - "null" types: items: $ref: "#/components/schemas/QcStatements_QcType" type: - array - "null" type: object QcStatements_PdsLocation: additionalProperties: false properties: language: type: string url: type: string type: object QcStatements_QCLegislation: additionalProperties: false properties: country_codes: items: type: string type: - array - "null" type: object QcStatements_QcType: additionalProperties: false properties: ids: items: type: string type: - array - "null" type: object RSACryptographicKey: additionalProperties: false properties: exponent: format: base64 type: string length: format: int32 minimum: 0 type: integer modulus: format: base64 type: string type: object RawCertificateResponse: additionalProperties: false properties: certificate_id: type: string pem: type: string required: - certificate_id - pem type: object Rdate: additionalProperties: false properties: date: type: string type: object Rdp: additionalProperties: false properties: certificate_info: $ref: "#/components/schemas/Rdp_CertificateInfo" connect_response: $ref: "#/components/schemas/Rdp_ConnectResponse" protocol_flags: $ref: "#/components/schemas/Rdp_ProtocolFlags" selected_security_protocol: $ref: "#/components/schemas/Rdp_SecurityProtocol" version: $ref: "#/components/schemas/Rdp_Version" x224_cc_pdu_dstref: format: int32 minimum: 0 type: integer x224_cc_pdu_srcref: format: int32 minimum: 0 type: integer type: object Rdp_CertificateInfo: additionalProperties: false properties: internal_x509_chain_fps: format: hex items: type: string type: - array - "null" proprietary_rsa_key: $ref: "#/components/schemas/Rdp_EmbeddedRSACert" type: object Rdp_ConnectResponse: additionalProperties: false properties: connect_id: format: int32 minimum: 0 type: integer domain_parameters: $ref: "#/components/schemas/Rdp_DomainParameters" type: object Rdp_DomainParameters: additionalProperties: false properties: domain_protocol_version: format: int64 type: integer max_channel_ids: format: int64 type: integer max_mcspdu_size: format: int64 type: integer max_provider_height: format: int64 type: integer max_token_ids: format: int64 type: integer max_user_id_channels: format: int64 type: integer min_throughput: format: int64 type: integer num_priorities: format: int64 type: integer type: object Rdp_EmbeddedRSACert: additionalProperties: false properties: key_length: format: int32 minimum: 0 type: integer magic: format: int32 minimum: 0 type: integer max_bytes_datalen: format: int32 minimum: 0 type: integer modulus: type: string modulus_bitlen: format: int32 minimum: 0 type: integer public_exponent: format: int32 minimum: 0 type: integer signature: type: string type: object Rdp_ProtocolFlags: additionalProperties: false properties: dynvc_graphics_pipeline: type: boolean extended_client_data_supported: type: boolean neg_resp_reserved: type: boolean restricted_admin_mode: type: boolean restricted_auth_mode: type: boolean type: object Rdp_SecurityProtocol: additionalProperties: false properties: credssp: type: boolean credssp_early_auth: type: boolean error: type: boolean error_bad_flags: type: boolean error_hybrid_required: type: boolean error_ssl_cert_missing: type: boolean error_ssl_forbidden: type: boolean error_ssl_required: type: boolean error_ssl_user_auth_required: type: boolean error_unknown: type: boolean raw_value: format: int32 minimum: 0 type: integer rdstls: type: boolean standard_rdp: type: boolean tls: type: boolean type: object Rdp_Version: additionalProperties: false properties: major: format: int32 type: integer minor: format: int32 type: integer raw: description: Raw Version Response, Major version is stored in upper 2 bytes, minor in lower 2 bytes. format: hex type: string type: object Realport: additionalProperties: false properties: hardware_id: format: int32 minimum: 0 type: integer hardware_version: format: int32 minimum: 0 type: integer num_ports: format: int32 minimum: 0 type: integer product_name: format: utf8 type: string software_version: format: int32 minimum: 0 type: integer unpatched_etherlite: type: boolean vpd: additionalProperties: type: string format: utf8 type: object type: object RecordingCapabilities: additionalProperties: false properties: dynamic_recordings: type: boolean dynamic_tracks: type: boolean encoding: type: string max_rate: format: int32 minimum: 0 type: integer max_recordings: format: int32 minimum: 0 type: integer max_recordings_job: format: int32 minimum: 0 type: integer max_total_rate: format: int32 minimum: 0 type: integer options: type: boolean type: object Redis: additionalProperties: false properties: arch_bits: description: The architecture bits (32 or 64) the Redis server used to build. type: string auth_response: description: The response from the AUTH command, if sent. type: string build_id: description: The Build ID of the Redis server. type: string commands: description: The list of commands actually sent to the server, serialized in inline format, like 'PING' or 'AUTH somePassword'. items: type: string type: - array - "null" commands_processed: description: The total number of commands processed by the server. format: int32 minimum: 0 type: integer connections_received: description: The total number of connections accepted by the server. format: int32 minimum: 0 type: integer gcc_version: description: The version of the GCC compiler used to compile the Redis server. type: string git_sha1: description: The Sha-1 Git commit hash the Redis server used. type: string info_response: additionalProperties: type: string description: The response from the INFO command. Should be a series of key:value pairs separated by CRLFs. type: object major: description: Major is the version's major number. format: int32 minimum: 0 type: integer mem_allocator: description: The memory allocator. type: string minor: description: Minor is the version's major number. format: int32 minimum: 0 type: integer mode: description: The mode the Redis server is running (standalone or cluster), read from the the info_response (if available). type: string nonexistent_response: description: The response from the NONEXISTENT command. type: string os: description: The OS the Redis server is running, read from the the info_response (if available). type: string patch_level: description: Patchlevel is the version's patchlevel number. format: int32 minimum: 0 type: integer ping_response: description: The response from the PING command; should either be "PONG" or an authentication error. type: string quit_response: description: The response to the QUIT command. type: string raw_command_output: description: The raw output returned by the server for each command sent; the indices match those of commands. items: $ref: "#/components/schemas/Redis_RawOutput" type: - array - "null" uptime: description: The number of seconds since Redis server start. format: int32 minimum: 0 type: integer used_memory: description: The total number of bytes allocated by Redis using its allocator. format: int32 minimum: 0 type: integer type: object Redis_RawOutput: additionalProperties: false properties: output: format: hex type: string type: object Redline: additionalProperties: false properties: action_response: type: string settings_response: type: string transport: type: string type: object RedlionCrimson: additionalProperties: false properties: configs_exposed: type: boolean control_engine_status: type: string current_software_level: type: string execution_status: type: string manufacturer: type: string model: type: string type: object RedlionWeb: additionalProperties: false properties: enhanced_web_server: type: boolean log_names: items: type: string type: - array - "null" title: type: string type: object Reject: additionalProperties: false properties: reason: type: string type: enum: - "" - wrong_version - invalid_username - wrong_user_pw - wrong_server_pw - username_in_use - server_full - no_certificate - authenticator_fail type: string type: object ReplayCapabilities: additionalProperties: false properties: reverse_playback: type: boolean rtp_rtsp_tcp: type: boolean session_timeout_range: type: string type: object RepresentativeInfo: additionalProperties: false properties: excluded_ports: items: format: int32 minimum: 0 type: integer type: - array - "null" reason: enum: - "" - protocol_port_count - incapsula - zscaler type: string represented_ports: items: format: int32 minimum: 0 type: integer type: - array - "null" sampled_port: format: int32 minimum: 0 type: integer type: object Reputation: additionalProperties: false properties: evidence: items: $ref: "#/components/schemas/Reputation_Evidence" type: - array - "null" model_version: type: string score: format: float type: number score_level: enum: - "" - benign - low_risk - medium_risk - high_risk - malicious type: string type: object Reputation_Evidence: additionalProperties: false properties: additional_fields: items: $ref: "#/components/schemas/Reputation_Evidence_FieldValue" type: - array - "null" category: type: string evidence_score: format: float type: number external_signals: items: $ref: "#/components/schemas/Reputation_Evidence_ExternalSignal" type: - array - "null" threats: items: $ref: "#/components/schemas/Reputation_Evidence_Threat" type: - array - "null" type: object Reputation_Evidence_ExternalSignal: additionalProperties: false properties: description: type: string source: type: string tlp: enum: - "" - green - amber - red - white type: string type: object Reputation_Evidence_FieldValue: additionalProperties: false properties: field: type: string value: type: string type: object Reputation_Evidence_Threat: additionalProperties: false properties: last_observed_time: type: string threat_id: type: string threat_types: items: type: string type: - array - "null" type: object ResponseEnvelopeAuditLogEventsResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/AuditLogEventsResponse" type: object ResponseEnvelopeCenseyeJob: additionalProperties: false properties: result: $ref: "#/components/schemas/CenseyeJob" type: object ResponseEnvelopeCenseyeJobsListResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/CenseyeJobsListResponse" type: object ResponseEnvelopeCenseyeResultsResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/CenseyeResultsResponse" type: object ResponseEnvelopeCertificateAsset: additionalProperties: false properties: result: $ref: "#/components/schemas/CertificateAsset" type: object ResponseEnvelopeCollection: additionalProperties: false properties: result: $ref: "#/components/schemas/Collection" type: object ResponseEnvelopeCollectionEventsResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/CollectionEventsResponse" type: object ResponseEnvelopeComment: additionalProperties: false properties: result: $ref: "#/components/schemas/Comment" type: object ResponseEnvelopeCommentsList: additionalProperties: false properties: result: $ref: "#/components/schemas/CommentsList" type: object ResponseEnvelopeCreditUsageReport: additionalProperties: false properties: result: $ref: "#/components/schemas/CreditUsageReport" type: object ResponseEnvelopeDnsIpResolutionBoundResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/DnsIpResolutionBoundResponse" type: object ResponseEnvelopeDnsIpResolutionRangeResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/DnsIpResolutionRangeResponse" type: object ResponseEnvelopeDnsNameResolutionBoundResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/DnsNameResolutionBoundResponse" type: object ResponseEnvelopeDnsNameResolutionRangeResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/DnsNameResolutionRangeResponse" type: object ResponseEnvelopeHashObservationsOnHostResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/HashObservationsOnHostResponse" type: object ResponseEnvelopeHostAsset: additionalProperties: false properties: result: $ref: "#/components/schemas/HostAsset" type: object ResponseEnvelopeHostObservationResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/HostObservationResponse" type: object ResponseEnvelopeHostTimeline: additionalProperties: false properties: result: $ref: "#/components/schemas/HostTimeline" type: object ResponseEnvelopeListCertificateAsset: additionalProperties: false properties: result: items: $ref: "#/components/schemas/CertificateAsset" type: - array - "null" type: object ResponseEnvelopeListCollectionsResponseV1: additionalProperties: false properties: result: $ref: "#/components/schemas/ListCollectionsResponseV1" type: object ResponseEnvelopeListHostAsset: additionalProperties: false properties: result: items: $ref: "#/components/schemas/HostAsset" type: - array - "null" type: object ResponseEnvelopeListRawCertificateResponse: additionalProperties: false properties: result: items: $ref: "#/components/schemas/RawCertificateResponse" type: - array - "null" type: object ResponseEnvelopeListSearchConvertQueryResponse: additionalProperties: false properties: result: items: $ref: "#/components/schemas/SearchConvertQueryResponse" type: - array - "null" type: object ResponseEnvelopeListWebpropertyAsset: additionalProperties: false properties: result: items: $ref: "#/components/schemas/WebpropertyAsset" type: - array - "null" type: object ResponseEnvelopeOrganizationCredits: additionalProperties: false properties: result: $ref: "#/components/schemas/OrganizationCredits" type: object ResponseEnvelopeOrganizationDetails: additionalProperties: false properties: result: $ref: "#/components/schemas/OrganizationDetails" type: object ResponseEnvelopeOrganizationMembersList: additionalProperties: false properties: result: $ref: "#/components/schemas/OrganizationMembersList" type: object ResponseEnvelopeSearchAggregateResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/SearchAggregateResponse" type: object ResponseEnvelopeSearchQueryResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/SearchQueryResponse" type: object ResponseEnvelopeServicesOnHostResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/ServicesOnHostResponse" type: object ResponseEnvelopeSupplyChainSearchSuppliersPayload: additionalProperties: false properties: result: $ref: "#/components/schemas/SupplyChainSearchSuppliersPayload" type: object ResponseEnvelopeSupplyChainsListPayload: additionalProperties: false properties: result: $ref: "#/components/schemas/SupplyChainsListPayload" type: object ResponseEnvelopeTag: additionalProperties: false properties: result: $ref: "#/components/schemas/Tag" type: object ResponseEnvelopeTagAssignment: additionalProperties: false properties: result: $ref: "#/components/schemas/TagAssignment" type: object ResponseEnvelopeTagAssignmentsList: additionalProperties: false properties: result: $ref: "#/components/schemas/TagAssignmentsList" type: object ResponseEnvelopeTagsList: additionalProperties: false properties: result: $ref: "#/components/schemas/TagsList" type: object ResponseEnvelopeThreatsListResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/ThreatsListResponse" type: object ResponseEnvelopeThreatsOnHostResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/ThreatsOnHostResponse" type: object ResponseEnvelopeThreatsOnWebResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/ThreatsOnWebResponse" type: object ResponseEnvelopeTrackedScan: additionalProperties: false properties: result: $ref: "#/components/schemas/TrackedScan" type: object ResponseEnvelopeUserCredits: additionalProperties: false properties: result: $ref: "#/components/schemas/UserCredits" type: object ResponseEnvelopeValueCountsResponse: additionalProperties: false properties: result: $ref: "#/components/schemas/ValueCountsResponse" type: object ResponseEnvelopeWebpropertyAsset: additionalProperties: false properties: result: $ref: "#/components/schemas/WebpropertyAsset" type: object ReverseDnsResolved: additionalProperties: false properties: names: items: type: string type: - array - "null" resolve_time: type: string type: object Rifatron: additionalProperties: false properties: model: type: string type: object Ripple: additionalProperties: false properties: ripple_clio: $ref: "#/components/schemas/RippleClioResults" rippled_peer: $ref: "#/components/schemas/RipplePeerResults" rippled_public: $ref: "#/components/schemas/RippledPublicResults" type: object RippleClioResults: additionalProperties: false properties: clio_version: type: string rippled_version: type: string validated: type: boolean validation_quorum: format: int64 type: integer type: object RipplePeerResults: additionalProperties: false properties: build_version: type: string peer_crawler_response_version: format: int64 type: integer peers: items: $ref: "#/components/schemas/Peer" type: - array - "null" pubkey_node: type: string publisher_list: items: type: string type: - array - "null" server_state: type: string validator_sites: items: type: string type: - array - "null" type: object RippledPublicResults: additionalProperties: false properties: build_version: type: string hostid: type: string network_id: format: int64 type: integer peers: format: int64 type: integer ports: items: $ref: "#/components/schemas/Port" type: - array - "null" pubkey_node: type: string server_state: type: string validation_quorum: format: int64 type: integer type: object Risk: additionalProperties: false properties: confidence: format: double type: number cvss: $ref: "#/components/schemas/CVSS" evidence: items: $ref: "#/components/schemas/Evidence" type: - array - "null" id: type: string metrics: $ref: "#/components/schemas/Metrics" name: type: string risk_source: enum: - "" - censys - cve type: string severity: enum: - "" - low - medium - high - critical type: string source: enum: - "" - censys - recog - wappalyzer - third_party - html_meta_extractor type: string year: format: int32 minimum: 0 type: integer type: object Rlogin: additionalProperties: false properties: error: type: string operating_system: type: string software: type: string software_version: type: string type: object Rocketmq: additionalProperties: false properties: cluster_info: $ref: "#/components/schemas/Rocketmq_ClusterInfo" topics: $ref: "#/components/schemas/Rocketmq_TopicList" version: type: string type: object Rocketmq_ClusterInfo: additionalProperties: false properties: header: $ref: "#/components/schemas/Rocketmq_ResponseHeader" payload: type: string type: object Rocketmq_ResponseHeader: additionalProperties: false properties: code: format: int64 type: integer flag: format: int64 type: integer language: type: string opaque: format: int64 type: integer serialize_type_current_rpc: type: string type: object Rocketmq_TopicList: additionalProperties: false properties: header: $ref: "#/components/schemas/Rocketmq_ResponseHeader" topic_list: items: type: string type: - array - "null" type: object RootStore: additionalProperties: false properties: chains: description: A path of trusted signing certificates up to a root certificate present in a root store, represented as an ordered list of SHA-256 fingerprints. items: $ref: "#/components/schemas/RootStore_Chain" type: - array - "null" ever_valid: description: Whether the certificate has ever been considered valid by the root store. type: boolean had_trusted_path: description: Whether there ever existed a trusted path of signing certificates from a certificate present in the root certificate store. type: boolean has_trusted_path: description: Whether there currently exists a trusted path of signing certificates from a certificate present in the root certificate store. type: boolean in_revocation_set: description: Whether the certificate is in the revocation set (e.g. OneCRL) associated with the root store. type: boolean is_valid: description: "Whether the certificate is currently considered valid by the root store: a summary of the trust path, revoked, blocklisted/allowlisted, and expired fields." type: boolean parents: description: The SHA-256 fingerprints of the certificate's immediate parents in its trust path(s). format: hex items: type: string type: - array - "null" type: description: The certificate's type. Options include root, intermediate, or leaf. enum: - "" - root - intermediate - leaf type: string type: object RootStore_Chain: additionalProperties: false properties: sha256fp: format: hex items: type: string type: - array - "null" type: object RouteUpdated: additionalProperties: false properties: diff: additionalProperties: $ref: "#/components/schemas/FieldDiff" type: object route: $ref: "#/components/schemas/AutonomousSystem" type: object RouterosApi: additionalProperties: false properties: message: type: string raw_response: format: hex type: string reply_word: type: string type: object Routing: additionalProperties: false properties: asn: description: The ASN (autonomous system number) of the host's autonomous system. format: int32 minimum: 0 type: integer bgp_prefix: description: The autonomous system's CIDR. type: string country_code: description: The autonomous system's two-letter ISO 3166-1 alpha-2 country code (US, CN, GB, RU, ...). type: string description: description: Brief description of the autonomous system. type: string name: description: The friendly name of the autonomous system. type: string organization: description: The name of the organization managning the autonomous system. type: string type: object RsaPublicKey: additionalProperties: false properties: exponent: description: The RSA key's public exponent (e). format: int64 type: integer length: description: Bit-length of the RSA modulus. format: int64 type: integer modulus: description: The RSA key's modulus (n) in big-endian encoding. format: hex type: string type: object Rtsp: additionalProperties: false properties: auth: format: utf8 type: string commands: format: utf8 items: type: string type: - array - "null" server: format: utf8 type: string www_auth: format: utf8 type: string type: object RustdeskHeartbeat: additionalProperties: false properties: message_type: type: string register_peer_response: $ref: "#/components/schemas/RustdeskHeartbeat_RegisterPeerResponse" type: object RustdeskHeartbeat_RegisterPeerResponse: additionalProperties: false properties: request_public_key: type: boolean type: object RustdeskRelay: additionalProperties: false properties: open_relay: type: boolean type: object RustdeskRendezvous: additionalProperties: false properties: key_exchange: $ref: "#/components/schemas/RustdeskRendezvous_KeyExchange" message_type: type: string test_nat_response: $ref: "#/components/schemas/RustdeskRendezvous_TestNatResponse" type: object RustdeskRendezvous_ConfigUpdate: additionalProperties: false properties: rendezvous_servers: items: type: string type: - array - "null" serial: format: int32 type: integer type: object RustdeskRendezvous_KeyExchange: additionalProperties: false properties: keys: format: hex items: type: string type: - array - "null" type: object RustdeskRendezvous_TestNatResponse: additionalProperties: false properties: config_update: $ref: "#/components/schemas/RustdeskRendezvous_ConfigUpdate" port: format: int32 type: integer type: object S7: additionalProperties: false properties: copyright: type: string cpu_profile: type: string firmware: type: string hardware: type: string location: type: string memory_serial_number: type: string module: type: string module_id: type: string module_type: type: string oem_id: type: string plant_id: type: string reserved_for_os: type: string serial_number: type: string system: type: string type: object SapRouter: additionalProperties: false properties: router_info: $ref: "#/components/schemas/SapRouter_RouterInfo" router_version_info: $ref: "#/components/schemas/SapRouter_RouterVersionInfo" type: object SapRouter_ClientInfo: additionalProperties: false properties: connected: type: boolean connected_on: type: string id: format: int32 minimum: 0 type: integer routed: type: boolean service: type: string traced: type: boolean type: object SapRouter_RouterInfo: additionalProperties: false properties: connected_client_info: items: $ref: "#/components/schemas/SapRouter_ClientInfo" type: - array - "null" num_clients: format: int64 minimum: 0 type: integer parent_pid: format: int32 minimum: 0 type: integer parent_port: format: int32 minimum: 0 type: integer pid: format: int32 minimum: 0 type: integer port: format: int32 minimum: 0 type: integer routtab_relative_directory: type: string sap_router_absolute_directory: type: string started_on: type: string type: object SapRouter_RouterVersionInfo: additionalProperties: false properties: name: type: string release: format: int64 minimum: 0 type: integer version: format: int64 minimum: 0 type: integer type: object Sapient: additionalProperties: false properties: error: $ref: "#/components/schemas/Sapient_Error" payload: format: hex type: string registration_ack: $ref: "#/components/schemas/Sapient_RegistrationAck" unknown: format: hex type: string type: object Sapient_Error: additionalProperties: false properties: error_message: items: type: string type: - array - "null" packet: format: hex type: string type: object Sapient_RegistrationAck: additionalProperties: false properties: acceptance: type: boolean ack_response_reason: items: type: string type: - array - "null" type: object ScadaView: additionalProperties: false properties: description: type: string title: type: string type: object ScansDiscoveryInputBody: additionalProperties: false properties: target: oneOf: - description: Discovery scan against IP:PORT properties: host_port: additionalProperties: false properties: ip: description: IP address to scan examples: - 8.8.8.8 type: string port: description: Port number to scan examples: - 443 format: int32 maximum: 65535 minimum: 1 type: integer required: - ip - port type: object required: - host_port type: object - description: Discovery scan against hostname:PORT properties: hostname_port: additionalProperties: false properties: hostname: description: Hostname to scan examples: - censys.io type: string port: description: Port number to scan examples: - 443 format: int32 maximum: 65535 minimum: 1 type: integer required: - hostname - port type: object required: - hostname_port type: object type: object required: - target type: object ScansRescanInputBody: additionalProperties: false properties: target: oneOf: - description: Rescan of known service properties: service_id: additionalProperties: false properties: ip: description: IP address of service examples: - 8.8.8.8 type: string port: description: Port number of service examples: - 443 format: int32 maximum: 65535 minimum: 1 type: integer protocol: description: Name of service protocol examples: - HTTP type: string transport_protocol: enum: - unknown - tcp - udp - icmp - quic type: string required: - ip - port - protocol - transport_protocol type: object required: - service_id type: object - description: Rescan of known web property properties: web_origin: additionalProperties: false properties: hostname: description: Hostname of the web origin examples: - censys.io type: string port: description: Port number of the web origin examples: - 443 format: int32 maximum: 65535 minimum: 1 type: integer required: - hostname - port type: object required: - web_origin type: object type: object required: - target type: object Scpi: additionalProperties: false properties: firmware: format: utf8 type: string manufacturer: format: utf8 type: string model: format: utf8 type: string serial: format: utf8 type: string type: object Screenshot: additionalProperties: false properties: extracted_text: type: string handle: type: string palsimhash: format: hex type: string phash: format: hex type: string type: object SearchAggregateInputBody: additionalProperties: false properties: count_by_level: description: "Specifies which document level's count is returned per term bucket, primarily for nested fields. This is the same functionality available in the Count By dropdown in the Report Builder UI. When aggregating on nested fields like 'host.services.port': empty string (default) counts documents at the deepest level containing the field; '.' counts root documents (e.g. counts matching 'host'); 'host.services' counts documents at the specified nested level." type: string field: description: field to aggregate by examples: - host.services.port type: string filter_by_query: default: false description: Controls whether aggregation results are limited to values that match the query. When true, only field values that satisfy the query constraints are included in aggregation counts. When false, aggregation includes all field values from records that match the query, even if those specific field values don't match the query constraints. For example, if the query is 'host.services.protocol=SSH' and you are aggregating by 'host.services.port' - when true, only shows SSH ports; when false, shows all ports on hosts that have SSH services. type: boolean number_of_buckets: description: number of buckets to split results into examples: - "100" format: int64 maximum: 2000 minimum: 1 type: integer query: description: CenQL query string to search upon examples: - host.services.protocol=SSH type: string required: - query - field - number_of_buckets type: object SearchAggregateResponse: additionalProperties: false properties: buckets: items: $ref: "#/components/schemas/SearchAggregateResponseBucket" type: - array - "null" is_more_than_total_hits: type: boolean other_count: format: int64 type: integer query_duration_millis: format: int64 type: integer total_count: format: int64 type: integer required: - total_count - other_count - query_duration_millis - is_more_than_total_hits - buckets type: object SearchAggregateResponseBucket: additionalProperties: false properties: count: format: int64 type: integer key: type: string required: - key - count type: object SearchCapabilities: additionalProperties: false properties: general_start_events: type: boolean metadata_search: type: boolean type: object SearchConvertQueryInputBody: additionalProperties: false properties: queries: description: A list of Censys Search Language queries to convert. Limited to 100 queries. items: type: string maxItems: 100 type: - array - "null" required: - queries type: object SearchConvertQueryResponse: additionalProperties: false properties: alternative_queries: description: Alternative queries that may be used. For example, a query that includes web results in addition to host results. items: $ref: "#/components/schemas/AlternativeQuery" type: - array - "null" comments: description: Comments about the query conversion. items: type: string type: - array - "null" converted_query: description: The original query, converted to CenQL syntax. This may be empty if unable to translate the query. type: string errors: description: The error messages if the query could not be converted. items: $ref: "#/components/schemas/ConvertQueryError" type: - array - "null" original_query: description: The original Censys Search Language query. type: string targets: description: "The types of Platform data records (host, cert, and web) that can be targeted by the converted query. Note: Does not include targets that could be returned due to full-document search. This may be empty if the query is a match-all for full-document search query." items: enum: - host - web - cert - unknown type: string type: - array - "null" required: - original_query - errors - targets type: object SearchQueryHit: additionalProperties: false properties: certificate_v1: $ref: "#/components/schemas/CertificateAsset" host_v1: $ref: "#/components/schemas/HostAssetWithMatchedServices" tags: description: Tags applied to this asset. items: $ref: "#/components/schemas/SearchQueryTagInfo" type: - array - "null" webproperty_v1: $ref: "#/components/schemas/WebpropertyAsset" type: object SearchQueryInputBody: additionalProperties: false properties: fields: description: Specify fields to only return in the response. If you provide fields and omit `host.services.port`, `host.services.transport_protocol`, and `host.services.protocol`, then `matched_services` will not be returned in the response. examples: - host.ip items: type: string type: - array - "null" page_size: description: Number of results to return to per page. The default and maximum is 100. examples: - "1" format: int64 minimum: 0 type: - integer - "null" page_token: description: page token for the requested page of search results type: string query: description: CenQL query string to search upon examples: - "host.services: (protocol=SSH and not port: 22)" type: string required: - query type: object SearchQueryResponse: additionalProperties: false properties: hits: items: $ref: "#/components/schemas/SearchQueryHit" type: - array - "null" next_page_token: type: string previous_page_token: type: string query_duration_millis: format: int32 type: integer total_hits: format: double type: number required: - total_hits - next_page_token - previous_page_token - query_duration_millis - hits type: object SearchQueryTagInfo: additionalProperties: false properties: display_name: description: Name of the tag. type: string id: description: ID of the tag. format: uuid type: string required: - display_name type: object SearchValueCountsInputBody: additionalProperties: false properties: and_count_conditions: description: Groups of field-value pairs to count matches for. Each group may contain up to 5 field-value pairs. items: $ref: "#/components/schemas/CountCondition" type: - array - "null" query: description: CenQL query string to filter documents type: string required: - and_count_conditions type: object SecurityCapabilities: additionalProperties: false properties: access_policy_config: type: boolean default_access_policy: type: boolean dot1x: type: boolean http_digest: type: boolean kerberos_token: type: boolean max_password_length: format: int32 minimum: 0 type: integer max_username_length: format: int32 minimum: 0 type: integer max_users: format: int32 minimum: 0 type: integer onboard_key_generation: type: boolean rel_token: type: boolean remote_user_handling: type: boolean saml_token: type: boolean supported_eap_methods: format: int32 minimum: 0 type: integer tls_1_0: type: boolean tls_1_1: type: boolean tls_1_2: type: boolean username_token: type: boolean x509_token: type: boolean type: object Ser2Net: additionalProperties: false properties: device: type: string os: type: string serial_parameters: $ref: "#/components/schemas/Ser2Net_SerialParameters" software: type: string software_version: type: string type: object Ser2Net_SerialParameters: additionalProperties: false properties: baud_rate: type: string data_bits: type: string parity: type: string stop_bits: type: string type: object ServerConfig: additionalProperties: false properties: allow_html: type: boolean image_message_length: format: int32 minimum: 0 type: integer max_bandwidth: format: int32 minimum: 0 type: integer max_users: format: int32 minimum: 0 type: integer message_length: format: int32 minimum: 0 type: integer recording_allowed: type: boolean welcome_text: type: string type: object ServerSync: additionalProperties: false properties: max_bandwidth: format: int32 minimum: 0 type: integer permissions: items: type: string type: - array - "null" welcome_text: type: string type: object Service: additionalProperties: false properties: activemq: $ref: "#/components/schemas/Activemq" amqp: $ref: "#/components/schemas/Amqp" anerma_cf_forth: $ref: "#/components/schemas/AnermaCfForth" any_connect: $ref: "#/components/schemas/AnyConnect" asterisk_manager_interface: $ref: "#/components/schemas/AsteriskManagerInterface" bacnet: $ref: "#/components/schemas/Bacnet" banner: format: utf8 type: string banner_hash_sha256: format: hex type: string banner_hex: type: string cert: $ref: "#/components/schemas/Certificate" checkpoint_topology: $ref: "#/components/schemas/CheckpointTopology" chromecast: $ref: "#/components/schemas/Chromecast" cisco_ipsla: $ref: "#/components/schemas/CiscoIpsla" cmore: $ref: "#/components/schemas/Cmore" coap: $ref: "#/components/schemas/Coap" crestron_cp3: $ref: "#/components/schemas/CrestronCp3" crestron_din_ap2: $ref: "#/components/schemas/CrestronDinAp2" cursor_on_target: $ref: "#/components/schemas/CursorOnTarget" cwmp: $ref: "#/components/schemas/Cwmp" darkcomet: $ref: "#/components/schemas/Darkcomet" darkgate: $ref: "#/components/schemas/Darkgate" dcerpc: $ref: "#/components/schemas/Dcerpc" dhcpdiscover: $ref: "#/components/schemas/Dhcpdiscover" dnp3: $ref: "#/components/schemas/Dnp3" dns: $ref: "#/components/schemas/Dns" dtls: $ref: "#/components/schemas/Dtls" dvr_ip: $ref: "#/components/schemas/DvrIp" eip: $ref: "#/components/schemas/Eip" elf_file: $ref: "#/components/schemas/ElfFile" endpoints: items: $ref: "#/components/schemas/EndpointScanState" type: - array - "null" epmd: $ref: "#/components/schemas/Epmd" etcd: $ref: "#/components/schemas/Etcd" ethereum: $ref: "#/components/schemas/Ethereum" exposures: items: $ref: "#/components/schemas/Risk" type: - array - "null" flash_socket_policy: $ref: "#/components/schemas/FlashSocketPolicy" fox: $ref: "#/components/schemas/Fox" frps: $ref: "#/components/schemas/Frps" ftp: $ref: "#/components/schemas/Ftp" gearman: $ref: "#/components/schemas/Gearman" gemini: $ref: "#/components/schemas/Gemini" hajime: $ref: "#/components/schemas/Hajime" hardware: items: $ref: "#/components/schemas/Attribute" type: - array - "null" hid_vertx: $ref: "#/components/schemas/HidVertx" hikvision: $ref: "#/components/schemas/Hikvision" ibmnje: $ref: "#/components/schemas/Ibmnje" icap: $ref: "#/components/schemas/Icap" ike: $ref: "#/components/schemas/Ike" imap: $ref: "#/components/schemas/Imap" iota: $ref: "#/components/schemas/Iota" ip: type: string ipmi: $ref: "#/components/schemas/Ipmi" ipp: $ref: "#/components/schemas/Ipp" iscsi: $ref: "#/components/schemas/Iscsi" ja4tscan: $ref: "#/components/schemas/JA4TScanScan" jarm: $ref: "#/components/schemas/JarmScan" krpc: $ref: "#/components/schemas/Krpc" l2tp: $ref: "#/components/schemas/L2Tp" labels: items: $ref: "#/components/schemas/Label" type: - array - "null" ldap: $ref: "#/components/schemas/Ldap" lpd: $ref: "#/components/schemas/Lpd" mavlink: $ref: "#/components/schemas/Mavlink" mdns: $ref: "#/components/schemas/Mdns" melsec: $ref: "#/components/schemas/Melsec" memberlist: $ref: "#/components/schemas/Memberlist" memcached: $ref: "#/components/schemas/Memcached" mikrotik_winbox: $ref: "#/components/schemas/MikrotikWinbox" minecraft: $ref: "#/components/schemas/Minecraft" misconfigs: items: $ref: "#/components/schemas/Risk" type: - array - "null" mms: $ref: "#/components/schemas/Mms" modbus: $ref: "#/components/schemas/Modbus" monero_p2p: $ref: "#/components/schemas/MoneroP2P" mongodb: $ref: "#/components/schemas/Mongodb" mqtt: $ref: "#/components/schemas/Mqtt" mssql: $ref: "#/components/schemas/Mssql" murmur: $ref: "#/components/schemas/Murmur" mysql: $ref: "#/components/schemas/Mysql" nats_io: $ref: "#/components/schemas/NatsIo" nbd: $ref: "#/components/schemas/Nbd" nfs_mountd: $ref: "#/components/schemas/NfsMountd" nmea: $ref: "#/components/schemas/Nmea" ntp: $ref: "#/components/schemas/Ntp" ntrip: $ref: "#/components/schemas/Ntrip" onc: $ref: "#/components/schemas/Onc" onvif: $ref: "#/components/schemas/Onvif" opc_ua: $ref: "#/components/schemas/OpcUa" openvpn: $ref: "#/components/schemas/Openvpn" openvpn_mgmt: $ref: "#/components/schemas/OpenvpnMgmt" operating_systems: items: $ref: "#/components/schemas/Attribute" type: - array - "null" oracle: $ref: "#/components/schemas/Oracle" pc_anywhere: $ref: "#/components/schemas/PcAnywhere" pgbouncer: $ref: "#/components/schemas/Pgbouncer" pop3: $ref: "#/components/schemas/Pop3" port: format: int32 minimum: 0 type: integer portmap: $ref: "#/components/schemas/Portmap" postgres: $ref: "#/components/schemas/Postgres" pptp: $ref: "#/components/schemas/Pptp" profinet_cm: $ref: "#/components/schemas/ProfinetCm" protocol: type: string rdate: $ref: "#/components/schemas/Rdate" rdp: $ref: "#/components/schemas/Rdp" realport: $ref: "#/components/schemas/Realport" redis: $ref: "#/components/schemas/Redis" redline: $ref: "#/components/schemas/Redline" redlion_crimson: $ref: "#/components/schemas/RedlionCrimson" representative_info: $ref: "#/components/schemas/RepresentativeInfo" rifatron: $ref: "#/components/schemas/Rifatron" ripple: $ref: "#/components/schemas/Ripple" rlogin: $ref: "#/components/schemas/Rlogin" rocketmq: $ref: "#/components/schemas/Rocketmq" routeros_api: $ref: "#/components/schemas/RouterosApi" rtsp: $ref: "#/components/schemas/Rtsp" rustdesk_heartbeat: $ref: "#/components/schemas/RustdeskHeartbeat" rustdesk_relay: $ref: "#/components/schemas/RustdeskRelay" rustdesk_rendezvous: $ref: "#/components/schemas/RustdeskRendezvous" s7: $ref: "#/components/schemas/S7" sap_router: $ref: "#/components/schemas/SapRouter" sapient: $ref: "#/components/schemas/Sapient" scan_time: type: string scpi: $ref: "#/components/schemas/Scpi" screenshots: items: $ref: "#/components/schemas/Screenshot" type: - array - "null" ser2net: $ref: "#/components/schemas/Ser2Net" seven_days_to_die: $ref: "#/components/schemas/SevenDaysToDie" sip: $ref: "#/components/schemas/Sip" skinny: $ref: "#/components/schemas/Skinny" smb: $ref: "#/components/schemas/Smb" smtp: $ref: "#/components/schemas/Smtp" snmp: $ref: "#/components/schemas/Snmp" socks: $ref: "#/components/schemas/Socks" software: items: $ref: "#/components/schemas/Attribute" type: - array - "null" spice: $ref: "#/components/schemas/Spice" ssdp: $ref: "#/components/schemas/Ssdp" ssh: $ref: "#/components/schemas/Ssh" steam: $ref: "#/components/schemas/Steam" stun: $ref: "#/components/schemas/Stun" tacacs_plus: $ref: "#/components/schemas/TacacsPlus" team_viewer: $ref: "#/components/schemas/TeamViewer" telnet: $ref: "#/components/schemas/Telnet" threats: items: $ref: "#/components/schemas/Threat" type: - array - "null" tibia: $ref: "#/components/schemas/Tibia" tls: $ref: "#/components/schemas/Tls" tplink_kasa: $ref: "#/components/schemas/TplinkKasa" transport_protocol: enum: - "" - tcp - udp - icmp - quic type: string unitronics_pcom: $ref: "#/components/schemas/UnitronicsPcom" upnp: $ref: "#/components/schemas/Upnp" ventrilo: $ref: "#/components/schemas/Ventrilo" vnc: $ref: "#/components/schemas/Vnc" vulns: items: $ref: "#/components/schemas/Vuln" type: - array - "null" weblogic_t3: $ref: "#/components/schemas/WeblogicT3" winrm: $ref: "#/components/schemas/Winrm" ws_discovery: $ref: "#/components/schemas/WsDiscovery" x11: $ref: "#/components/schemas/X11" zeromq: $ref: "#/components/schemas/Zeromq" type: object ServiceId: additionalProperties: false properties: ip: type: string port: format: int32 minimum: 0 type: integer protocol: type: string transport_protocol: enum: - "" - tcp - udp - icmp - quic type: string type: object ServiceOnHostRange: additionalProperties: false properties: end_time: description: When the service was last observed format: date-time type: string ip: description: IP address where the service was observed type: string port: description: Port number where the service was observed type: string protocol: description: Application protocol (e.g., HTTP, HTTPS) type: string start_time: description: When the service was first observed format: date-time type: string transport_protocol: description: Transport protocol (e.g., TCP, UDP, QUIC) type: string required: - ip - port - protocol - transport_protocol - start_time - end_time type: object ServiceScan: additionalProperties: false properties: activemq: $ref: "#/components/schemas/Activemq" amqp: $ref: "#/components/schemas/Amqp" anerma_cf_forth: $ref: "#/components/schemas/AnermaCfForth" any_connect: $ref: "#/components/schemas/AnyConnect" asterisk_manager_interface: $ref: "#/components/schemas/AsteriskManagerInterface" bacnet: $ref: "#/components/schemas/Bacnet" banner: format: utf8 type: string banner_hash_sha256: format: hex type: string checkpoint_topology: $ref: "#/components/schemas/CheckpointTopology" chromecast: $ref: "#/components/schemas/Chromecast" cisco_ipsla: $ref: "#/components/schemas/CiscoIpsla" cmore: $ref: "#/components/schemas/Cmore" coap: $ref: "#/components/schemas/Coap" crestron_cp3: $ref: "#/components/schemas/CrestronCp3" crestron_din_ap2: $ref: "#/components/schemas/CrestronDinAp2" cursor_on_target: $ref: "#/components/schemas/CursorOnTarget" cwmp: $ref: "#/components/schemas/Cwmp" darkcomet: $ref: "#/components/schemas/Darkcomet" darkgate: $ref: "#/components/schemas/Darkgate" dcerpc: $ref: "#/components/schemas/Dcerpc" dhcpdiscover: $ref: "#/components/schemas/Dhcpdiscover" dnp3: $ref: "#/components/schemas/Dnp3" dns: $ref: "#/components/schemas/Dns" dtls: $ref: "#/components/schemas/Dtls" dvr_ip: $ref: "#/components/schemas/DvrIp" eip: $ref: "#/components/schemas/Eip" elf_file: $ref: "#/components/schemas/ElfFile" epmd: $ref: "#/components/schemas/Epmd" etcd: $ref: "#/components/schemas/Etcd" ethereum: $ref: "#/components/schemas/Ethereum" flash_socket_policy: $ref: "#/components/schemas/FlashSocketPolicy" fox: $ref: "#/components/schemas/Fox" frps: $ref: "#/components/schemas/Frps" ftp: $ref: "#/components/schemas/Ftp" gearman: $ref: "#/components/schemas/Gearman" gemini: $ref: "#/components/schemas/Gemini" hajime: $ref: "#/components/schemas/Hajime" hid_vertx: $ref: "#/components/schemas/HidVertx" hikvision: $ref: "#/components/schemas/Hikvision" ibmnje: $ref: "#/components/schemas/Ibmnje" icap: $ref: "#/components/schemas/Icap" ike: $ref: "#/components/schemas/Ike" imap: $ref: "#/components/schemas/Imap" iota: $ref: "#/components/schemas/Iota" ip: type: string ipmi: $ref: "#/components/schemas/Ipmi" ipp: $ref: "#/components/schemas/Ipp" is_success: type: boolean iscsi: $ref: "#/components/schemas/Iscsi" krpc: $ref: "#/components/schemas/Krpc" l2tp: $ref: "#/components/schemas/L2Tp" ldap: $ref: "#/components/schemas/Ldap" lpd: $ref: "#/components/schemas/Lpd" mavlink: $ref: "#/components/schemas/Mavlink" mdns: $ref: "#/components/schemas/Mdns" melsec: $ref: "#/components/schemas/Melsec" memberlist: $ref: "#/components/schemas/Memberlist" memcached: $ref: "#/components/schemas/Memcached" mikrotik_winbox: $ref: "#/components/schemas/MikrotikWinbox" minecraft: $ref: "#/components/schemas/Minecraft" mms: $ref: "#/components/schemas/Mms" modbus: $ref: "#/components/schemas/Modbus" monero_p2p: $ref: "#/components/schemas/MoneroP2P" mongodb: $ref: "#/components/schemas/Mongodb" mqtt: $ref: "#/components/schemas/Mqtt" mssql: $ref: "#/components/schemas/Mssql" murmur: $ref: "#/components/schemas/Murmur" mysql: $ref: "#/components/schemas/Mysql" nats_io: $ref: "#/components/schemas/NatsIo" nbd: $ref: "#/components/schemas/Nbd" nfs_mountd: $ref: "#/components/schemas/NfsMountd" nmea: $ref: "#/components/schemas/Nmea" ntp: $ref: "#/components/schemas/Ntp" ntrip: $ref: "#/components/schemas/Ntrip" onc: $ref: "#/components/schemas/Onc" onvif: $ref: "#/components/schemas/Onvif" opc_ua: $ref: "#/components/schemas/OpcUa" openvpn: $ref: "#/components/schemas/Openvpn" openvpn_mgmt: $ref: "#/components/schemas/OpenvpnMgmt" oracle: $ref: "#/components/schemas/Oracle" pc_anywhere: $ref: "#/components/schemas/PcAnywhere" pgbouncer: $ref: "#/components/schemas/Pgbouncer" pop3: $ref: "#/components/schemas/Pop3" port: format: int32 minimum: 0 type: integer portmap: $ref: "#/components/schemas/Portmap" postgres: $ref: "#/components/schemas/Postgres" pptp: $ref: "#/components/schemas/Pptp" profinet_cm: $ref: "#/components/schemas/ProfinetCm" protocol: type: string rdate: $ref: "#/components/schemas/Rdate" rdp: $ref: "#/components/schemas/Rdp" realport: $ref: "#/components/schemas/Realport" redis: $ref: "#/components/schemas/Redis" redline: $ref: "#/components/schemas/Redline" redlion_crimson: $ref: "#/components/schemas/RedlionCrimson" representative_info: $ref: "#/components/schemas/RepresentativeInfo" rifatron: $ref: "#/components/schemas/Rifatron" ripple: $ref: "#/components/schemas/Ripple" rlogin: $ref: "#/components/schemas/Rlogin" rocketmq: $ref: "#/components/schemas/Rocketmq" routeros_api: $ref: "#/components/schemas/RouterosApi" rtsp: $ref: "#/components/schemas/Rtsp" rustdesk_heartbeat: $ref: "#/components/schemas/RustdeskHeartbeat" rustdesk_relay: $ref: "#/components/schemas/RustdeskRelay" rustdesk_rendezvous: $ref: "#/components/schemas/RustdeskRendezvous" s7: $ref: "#/components/schemas/S7" sap_router: $ref: "#/components/schemas/SapRouter" sapient: $ref: "#/components/schemas/Sapient" scan_time: type: string scpi: $ref: "#/components/schemas/Scpi" screenshots: items: $ref: "#/components/schemas/Screenshot" type: - array - "null" ser2net: $ref: "#/components/schemas/Ser2Net" seven_days_to_die: $ref: "#/components/schemas/SevenDaysToDie" sip: $ref: "#/components/schemas/Sip" skinny: $ref: "#/components/schemas/Skinny" smb: $ref: "#/components/schemas/Smb" smtp: $ref: "#/components/schemas/Smtp" snmp: $ref: "#/components/schemas/Snmp" socks: $ref: "#/components/schemas/Socks" spice: $ref: "#/components/schemas/Spice" ssdp: $ref: "#/components/schemas/Ssdp" ssh: $ref: "#/components/schemas/Ssh" steam: $ref: "#/components/schemas/Steam" stun: $ref: "#/components/schemas/Stun" tacacs_plus: $ref: "#/components/schemas/TacacsPlus" team_viewer: $ref: "#/components/schemas/TeamViewer" telnet: $ref: "#/components/schemas/Telnet" tibia: $ref: "#/components/schemas/Tibia" tls: $ref: "#/components/schemas/Tls" tplink_kasa: $ref: "#/components/schemas/TplinkKasa" transport_protocol: enum: - "" - tcp - udp - icmp - quic type: string unitronics_pcom: $ref: "#/components/schemas/UnitronicsPcom" upnp: $ref: "#/components/schemas/Upnp" ventrilo: $ref: "#/components/schemas/Ventrilo" vnc: $ref: "#/components/schemas/Vnc" weblogic_t3: $ref: "#/components/schemas/WeblogicT3" winrm: $ref: "#/components/schemas/Winrm" ws_discovery: $ref: "#/components/schemas/WsDiscovery" x11: $ref: "#/components/schemas/X11" zeromq: $ref: "#/components/schemas/Zeromq" type: object ServiceScanned: additionalProperties: false properties: diff: additionalProperties: $ref: "#/components/schemas/FieldDiff" type: object scan: $ref: "#/components/schemas/ServiceScan" type: object ServicesOnHostResponse: additionalProperties: false properties: next_page_token: description: A token that can be used to retrieve the next page of ranges. type: string ranges: description: The list of requested services. items: $ref: "#/components/schemas/ServiceOnHostRange" type: - array - "null" required: - ranges - next_page_token type: object SevenDaysToDie: additionalProperties: false properties: game_name: type: string game_type: type: string region: type: string server_url: type: string server_version: type: string steam_id: type: string version: type: string type: object Signature: additionalProperties: false properties: self_signed: description: Whether the certificate was signed by its own key. type: boolean signature_algorithm: $ref: "#/components/schemas/KeyAlgorithm" valid: description: Whether the signature is valid. type: boolean value: description: Contents of the signature. format: hex type: string type: object SignedCertificateTimestamp: additionalProperties: false properties: log_id: format: hex type: string signature: $ref: "#/components/schemas/SignedCertificateTimestamp_Signature" timestamp: type: string version: format: int32 type: integer type: object SignedCertificateTimestamp_Signature: additionalProperties: false properties: hash_algorithm: type: string signature: format: hex type: string signature_algorithm: type: string type: object Sip: additionalProperties: false properties: code: format: int32 type: integer server: description: Server software reported by service type: string status: type: string version: description: SIP version type: string type: object Skinny: additionalProperties: false properties: response: format: hex type: string type: object Smb: additionalProperties: false properties: group_name: description: Default group name type: string has_ntlm: description: Server supports the NTLM authentication method type: boolean native_os: description: Server-identified operating system type: string negotiation_log: $ref: "#/components/schemas/Smb_NegotiationLog" ntlm: description: Native LAN manager type: string session_setup_log: $ref: "#/components/schemas/Smb_SessionSetupLog" smb_capabilities: $ref: "#/components/schemas/Smb_SmbCapabilities" description: Capabilities flags for the connection. See [MS-SMB2] Sect. 2.2.4. smb_version: $ref: "#/components/schemas/Smb_SmbVersions" smbv1_support: type: boolean type: object Smb_HeaderLog: additionalProperties: false properties: command: format: int32 minimum: 0 type: integer credits: format: int32 minimum: 0 type: integer flags: format: int32 minimum: 0 type: integer protocol_id: format: hex type: string status: format: int32 minimum: 0 type: integer type: object Smb_NegotiationLog: additionalProperties: false properties: authentication_types: items: type: string type: - array - "null" capabilities: format: int32 minimum: 0 type: integer dialect_revision: format: int32 minimum: 0 type: integer header_log: $ref: "#/components/schemas/Smb_HeaderLog" security_mode: format: int32 minimum: 0 type: integer server_guid: format: hex type: string server_start_time: format: int32 minimum: 0 type: integer system_time: format: int32 minimum: 0 type: integer type: object Smb_SessionSetupLog: additionalProperties: false properties: header_log: $ref: "#/components/schemas/Smb_HeaderLog" negotiate_flags: format: int32 minimum: 0 type: integer setup_flags: format: int32 minimum: 0 type: integer target_name: type: string type: object Smb_SmbCapabilities: additionalProperties: false properties: smb_dfs_support: description: Server supports Distributed File System type: boolean smb_directory_leasing_support: description: Server supports directory leasing type: boolean smb_encryption_support: description: Server supports encryption type: boolean smb_leasing_support: description: Server supports Leasing type: boolean smb_multichan_support: description: Server supports multiple channels per session type: boolean smb_multicredit_support: description: Server supports multi-credit operations type: boolean smb_persistent_handle_support: description: Server supports persistent handles type: boolean type: object Smb_SmbVersions: additionalProperties: false properties: major: description: Major version format: int32 minimum: 0 type: integer minor: description: Minor version format: int32 minimum: 0 type: integer revision: description: Protocol Revision format: int32 minimum: 0 type: integer version_string: description: Full SMB Version String type: string type: object Smtp: additionalProperties: false properties: ehlo: description: The server's response to the EHLO command. format: utf8 type: string start_tls: description: The server's response to the STARTTLS command. format: utf8 type: string type: object Snmp: additionalProperties: false properties: engine: $ref: "#/components/schemas/Snmp_Engine" oid_interfaces: $ref: "#/components/schemas/Snmp_Interfaces" description: 1.3.6.1.2.1.2 - Interfaces oid_physical: $ref: "#/components/schemas/Snmp_Physical" description: 1.3.6.1.2.1.47.1.1.1.1 - Entity Physical oid_system: $ref: "#/components/schemas/Snmp_System" description: 1.3.6.1.2.1.1 - System Variables versions: items: type: string type: - array - "null" type: object Snmp_Engine: additionalProperties: false properties: description: type: string engine_boots: format: int32 minimum: 0 type: integer engine_time: format: int32 minimum: 0 type: integer format: type: string format_data: format: hex type: string organization: type: string pen: format: int32 minimum: 0 type: integer raw_id: type: string rfc3411: type: boolean type: object Snmp_Interfaces: additionalProperties: false properties: num_ifaces: description: 1.3.6.1.2.1.2.1 - Number of network interfaces format: int32 minimum: 0 type: integer type: object Snmp_Physical: additionalProperties: false properties: firmware_rev: description: 1.3.6.1.2.1.47.1.1.1.1.9 - Firmware revision string type: string hardware_rev: description: 1.3.6.1.2.1.47.1.1.1.1.8 - Hardware revision string type: string mfg_name: description: 1.3.6.1.2.1.47.1.1.1.1.12 - Name of mfg type: string model_name: description: 1.3.6.1.2.1.47.1.1.1.1.13 - Model name of component type: string name: description: 1.3.6.1.2.1.47.1.1.1.1.7 - Entity name type: string serial_num: description: 1.3.6.1.2.1.47.1.1.1.1.11 - Serial number string type: string software_rev: description: 1.3.6.1.2.1.47.1.1.1.1.10 - Software revision string type: string type: object Snmp_System: additionalProperties: false properties: contact: description: 1.3.6.1.2.1.1.4 - Contact info type: string desc: description: 1.3.6.1.2.1.1.1 - Description of entity type: string init_time: description: 1.3.6.1.2.1.1.3 - 1/100ths of sec format: int32 minimum: 0 type: integer location: description: 1.3.6.1.2.1.1.6 - Physical location type: string name: description: 1.3.6.1.2.1.1.5 - Name, usually FQDN type: string object_id: description: 1.3.6.1.2.1.1.2 - Vendor ID type: string services: $ref: "#/components/schemas/Snmp_System_Services" description: 1.3.6.1.2.1.1.7 - Set of services offered by entity type: object Snmp_System_Services: additionalProperties: false properties: layer_1: description: Physical (e.g. repeaters) type: boolean layer_2: description: Datalink/subnetwork (e.g. bridges) type: boolean layer_3: description: Internet (e.g. IP gateways) type: boolean layer_4: description: End-to-end (e.g. IP hosts) type: boolean layer_5: description: OSI layer 5 type: boolean layer_6: description: OSI layer 6 type: boolean layer_7: description: Applications (e.g. mail relays) type: boolean type: object Socks: additionalProperties: false properties: no_authentication_required: type: boolean preferred_authentication: type: string preferred_authentication_value: format: int32 minimum: 0 type: integer socks_version: format: int64 type: integer supported_versions: items: format: int64 type: integer type: - array - "null" type: object SourceUsageBreakdown: additionalProperties: false properties: api: description: The amount of credits consumed through the Platform API. format: int64 type: integer auto_replenishment: description: The amount of credits consumed through auto-replenishment. format: int64 type: integer other: description: The amount of credits consumed through other operations. format: int64 type: integer ui: description: The amount of credits consumed through the Platform UI. format: int64 type: integer required: - ui - api type: object Spice: additionalProperties: false properties: major_version: format: int32 minimum: 0 type: integer minor_version: format: int32 minimum: 0 type: integer tls_only: type: boolean x509_public_key: format: base64 type: string type: object Ssdp: additionalProperties: false properties: headers: additionalProperties: $ref: "#/components/schemas/Http_RepeatedHeaders" type: object upnp_url: type: string type: object Ssh: additionalProperties: false properties: algorithm_selection: $ref: "#/components/schemas/Ssh_AlgorithmSelection" endpoint_id: $ref: "#/components/schemas/Ssh_EndpointId" hassh_fingerprint: type: string kex_init_message: $ref: "#/components/schemas/Ssh_KexInitMessage" server_host_key: $ref: "#/components/schemas/Ssh_ServerHostKey" type: object Ssh_AlgorithmSelection: additionalProperties: false properties: client_to_server_alg_group: $ref: "#/components/schemas/Ssh_AlgorithmSelection_DirectionAlgorithms" host_key_algorithm: type: string kex_algorithm: type: string server_to_client_alg_group: $ref: "#/components/schemas/Ssh_AlgorithmSelection_DirectionAlgorithms" type: object Ssh_AlgorithmSelection_DirectionAlgorithms: additionalProperties: false properties: cipher: type: string compression: type: string mac: type: string type: object Ssh_EndpointId: additionalProperties: false properties: comment: type: string protocol_version: type: string raw: format: utf8 type: string software_version: type: string type: object Ssh_KexInitMessage: additionalProperties: false properties: client_to_server_ciphers: description: A list of ssh cipher algorithm identifiers, named according to section 6 of https://www.ietf.org/rfc/rfc4251.txt; see https://www.iana.org/assignments/ssh-parameters/ssh-parameters.xhtml#ssh-parameters-16 for standard values. items: type: string type: - array - "null" client_to_server_compression: description: A list of ssh compression algorithm identifiers, named according to section 6 of https://www.ietf.org/rfc/rfc4251.txt; see https://www.iana.org/assignments/ssh-parameters/ssh-parameters.xhtml#ssh-parameters-20 for standard values. items: type: string type: - array - "null" client_to_server_languages: description: A name-list of language tags in order of preference. As Defined in https://www.ietf.org/rfc/rfc3066.txt. items: type: string type: - array - "null" client_to_server_macs: description: A list of ssh MAC algorithm identifiers, named according to section 6 of https://www.ietf.org/rfc/rfc4251.txt; see https://www.iana.org/assignments/ssh-parameters/ssh-parameters.xhtml#ssh-parameters-18 for standard values. items: type: string type: - array - "null" first_kex_follows: type: boolean host_key_algorithms: description: Asymmetric key algorithms for the host key supported by the client. items: type: string type: - array - "null" kex_algorithms: description: Key exchange algorithms used in the handshake. items: type: string type: - array - "null" server_to_client_ciphers: description: A list of ssh cipher algorithm identifiers, named according to section 6 of https://www.ietf.org/rfc/rfc4251.txt; see https://www.iana.org/assignments/ssh-parameters/ssh-parameters.xhtml#ssh-parameters-16 for standard values. items: type: string type: - array - "null" server_to_client_compression: description: A list of ssh compression algorithm identifiers, named according to section 6 of https://www.ietf.org/rfc/rfc4251.txt; see https://www.iana.org/assignments/ssh-parameters/ssh-parameters.xhtml#ssh-parameters-20 for standard values. items: type: string type: - array - "null" server_to_client_languages: description: A name-list of language tags in order of preference. As Defined in https://www.ietf.org/rfc/rfc3066.txt. items: type: string type: - array - "null" server_to_client_macs: description: A list of ssh MAC algorithm identifiers, named according to section 6 of https://www.ietf.org/rfc/rfc4251.txt; see https://www.iana.org/assignments/ssh-parameters/ssh-parameters.xhtml#ssh-parameters-18 for standard values. items: type: string type: - array - "null" type: object Ssh_ServerHostKey: additionalProperties: false properties: certkey_public_key: format: utf8 type: string dsa_public_key: $ref: "#/components/schemas/DSACryptographicKey" ecdsa_public_key: $ref: "#/components/schemas/ECDSACryptographicKey" ed25519_public_key: $ref: "#/components/schemas/ED25519CryptographicKey" fingerprint_sha256: format: hex type: string rsa_public_key: $ref: "#/components/schemas/RSACryptographicKey" type: object Status: additionalProperties: false properties: available_workers: format: int32 type: integer function: type: string running: format: int32 type: integer total: format: int32 type: integer type: object Steam: additionalProperties: false properties: broadcasting_active: type: boolean connect_port: format: int32 minimum: 0 type: integer content_cache_port: format: int32 minimum: 0 type: integer download_lan_peer_group: format: int32 minimum: 0 type: integer enabled_services: format: int32 minimum: 0 type: integer euniverse: format: int32 type: integer games_running: type: boolean hostname: type: string ip_addresses: items: type: string type: - array - "null" is64bit: type: boolean mac_addresses: items: type: string type: - array - "null" min_version: format: int32 type: integer ostype: format: int32 type: integer public_ip_address: type: string remoteplay_active: type: boolean screen_locked: type: boolean steam_deck: type: boolean steam_version: type: string supported_services: format: int32 minimum: 0 type: integer users: items: $ref: "#/components/schemas/User" type: - array - "null" version: format: int32 type: integer vr_active: type: boolean vr_link_caps: type: string type: object Stun: additionalProperties: false properties: binding_error_response: $ref: "#/components/schemas/Stun_BindingErrorResponse" binding_success_response: $ref: "#/components/schemas/Stun_BindingSuccessResponse" response_type: format: int32 minimum: 0 type: integer response_type_name: type: string turn: $ref: "#/components/schemas/Stun_Turn" type: object Stun_BindingErrorResponse: additionalProperties: false properties: error_code: format: int32 type: integer error_reason: type: string has_fingerprint: type: boolean software: type: string type: object Stun_BindingSuccessResponse: additionalProperties: false properties: has_fingerprint: type: boolean other_address: $ref: "#/components/schemas/Stun_MappedAddress" software: type: string type: object Stun_MappedAddress: additionalProperties: false properties: ip: type: string port: format: int32 minimum: 0 type: integer type: object Stun_Turn: additionalProperties: false properties: allocate_error_response: $ref: "#/components/schemas/Stun_Turn_AllocateErrorResponse" allocate_success_response: $ref: "#/components/schemas/Stun_Turn_AllocateSuccessResponse" response_type: format: int32 minimum: 0 type: integer response_type_name: type: string type: object Stun_Turn_AllocateErrorResponse: additionalProperties: false properties: error_code: format: int32 type: integer error_reason: type: string has_fingerprint: type: boolean nonce: type: string realm: type: string software: type: string type: object Stun_Turn_AllocateSuccessResponse: additionalProperties: false properties: has_fingerprint: type: boolean relay_address: $ref: "#/components/schemas/Stun_MappedAddress" software: type: string type: object SubjectInfo: additionalProperties: false properties: display_name: description: A human-readable name for the subject resource, if available. The value and format depend on the subject type and may be omitted if not applicable. type: string id: description: The unique identifier of the subject resource. The identifier format depends on the subject type (for example, a Censys user ID or ASM workspace ID). Not all events will have a subject ID. type: string type: description: The type of resource that was affected by the audited action. enum: - organization - user - saml_config - pat - collection - organization_membership - organization_invitation - asm_workspace - asm_seed - asm_exclude - asm_risk_type - asm_risk_instance - global_data type: string required: - type type: object SubjectKeyInfo: additionalProperties: false properties: dsa: $ref: "#/components/schemas/DsaPublicKey" description: A record containing the public portion of a DSA asymmetric key. ecdsa: $ref: "#/components/schemas/EcdsaPublicKey" description: A record containing the public portion of an ECDSA asymmetric key. fingerprint_sha256: description: The SHA-256 digest of the certificate's DER-encoded SubjectPublicKeyInfo. format: hex type: string key_algorithm: $ref: "#/components/schemas/KeyAlgorithm" description: A record containing information about the type of subject key algorithm and any relevant parameters. rsa: $ref: "#/components/schemas/RsaPublicKey" description: A record containing the public portion of an RSA asymmetric key. unrecognized: $ref: "#/components/schemas/UnrecognizedPublicKey" description: A record containing known information about an unrecognized key type. type: object SupplyChainAddSuppliersBody: additionalProperties: false properties: supplier_ids: description: A list of IDs of Censys suppliers to add to the given supply chain, each as a UUID string, each must be unique. examples: - - 11111111-2222-3333-4444-555555555555 items: type: string maxItems: 1000 minItems: 1 type: - array - "null" supply_chain_id: description: The ID of a Censys supply chain. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string required: - supply_chain_id - supplier_ids type: object SupplyChainSearchSuppliersPayload: additionalProperties: false properties: suppliers: description: Suppliers matching the search keywords. items: $ref: "#/components/schemas/SupplyChainSupplier" type: - array - "null" required: - suppliers type: object SupplyChainSupplier: additionalProperties: false properties: city: description: Supplier headquarters city. type: string continent: description: Supplier headquarters continent. type: string country: description: Supplier headquarters country. type: string description: description: Supplier description. type: string display_name: description: Supplier display name. type: string id: description: Supplier ID. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string legal_name: description: Supplier legal name. type: string region: description: Supplier headquarters region or state. type: string status: description: Supplier status. type: string required: - id - display_name - legal_name - description - city - region - country - continent - status type: object SupplyChainsListPayload: additionalProperties: false properties: next_page_token: description: Pagination token for the next page of results, if any. type: string supply_chain_ids: description: Supply chain IDs for the organization. items: type: string type: - array - "null" required: - supply_chain_ids type: object SystemCapabilities: additionalProperties: false properties: discovery_bye: type: boolean discovery_resolve: type: boolean firmware_upgrade: type: boolean http_firmware_upgrade: type: boolean http_support_information: type: boolean http_system_backup: type: boolean http_system_logging: type: boolean remote_discovery: type: boolean storage_configuration: type: boolean system_backup: type: boolean system_logging: type: boolean type: object TacacsPlus: additionalProperties: false properties: data_length: format: int32 minimum: 0 type: integer flags: format: int32 minimum: 0 type: integer obfuscated: format: base64 type: string seq_num: format: int32 minimum: 0 type: integer session_id: format: int32 minimum: 0 type: integer type: format: int32 minimum: 0 type: integer version: format: int32 minimum: 0 type: integer type: object Tag: additionalProperties: false properties: created_at: description: RFC3339 timestamp when the tag was created. format: date-time type: string created_by: description: The user ID of the user who created the tag. format: uuid type: string description: description: A human-readable description of the tag. type: string id: description: The unique ID of the tag. format: uuid type: string name: description: The display name of the tag. type: string privacy: description: Tag visibility and management settings. `private` tags are only visible to and editable by organization admins. `shared` tags are visible to and editable by all organization members. enum: - private - shared type: string updated_at: description: RFC3339 timestamp when the tag was last updated. format: date-time type: string required: - id - name - privacy - created_at - updated_at - created_by type: object TagAssignment: additionalProperties: false properties: asset_id: description: The identifier of the tagged asset (host IP, certificate SHA-256 fingerprint, or web property domain/IP:port). type: string asset_type: description: The inferred type of the asset. enum: - host - certificate - web_property - unknown type: string created_at: description: RFC3339 timestamp when the assignment was created. format: date-time type: string created_by: description: The user ID of the user who created the assignment. format: uuid type: string id: description: The unique ID of the assignment. format: uuid type: string platform_ref: description: A direct URL to the asset in the Censys platform. type: string tag_id: description: The ID of the tag. format: uuid type: string required: - id - tag_id - asset_id - asset_type - platform_ref - created_at - created_by type: object TagAssignmentsList: additionalProperties: false properties: assignments: description: The list of tag assignments. items: $ref: "#/components/schemas/TagAssignment" type: - array - "null" next_page_token: description: Token to retrieve the next page of results. Omitted when there are no more results. type: string total_size: description: Total number of assignments matching the filters. format: int64 type: integer required: - assignments - total_size type: object TagsList: additionalProperties: false properties: next_page_token: description: Token to retrieve the next page of results. Omitted when there are no more results. type: string tags: description: The list of tags. items: $ref: "#/components/schemas/Tag" type: - array - "null" total_size: description: Total number of tags visible to the caller in this organization. format: int64 type: integer required: - tags - total_size type: object Target: additionalProperties: false properties: alias: type: string auths: items: type: string type: - array - "null" dns_portals: items: type: string type: - array - "null" errors: items: type: string type: - array - "null" name: type: string private_portals: items: type: string type: - array - "null" public_portals: items: type: string type: - array - "null" type: object TeamViewer: additionalProperties: false properties: response: format: hex type: string type: object Telnet: additionalProperties: false properties: do: additionalProperties: type: - string - "null" type: object dont: additionalProperties: type: - string - "null" type: object will: additionalProperties: type: - string - "null" type: object wont: additionalProperties: type: - string - "null" type: object type: object TextMessage: additionalProperties: false properties: actor: format: int32 minimum: 0 type: integer channel_id: items: format: int32 minimum: 0 type: integer type: - array - "null" message: type: string session: items: format: int32 minimum: 0 type: integer type: - array - "null" tree_id: items: format: int32 minimum: 0 type: integer type: - array - "null" type: object Threat: additionalProperties: false properties: actors: items: $ref: "#/components/schemas/Threat_Actor" type: - array - "null" confidence: format: double type: number details: $ref: "#/components/schemas/Threat_Details" evidence: items: $ref: "#/components/schemas/Evidence" type: - array - "null" id: type: string malware: $ref: "#/components/schemas/Threat_Malware" name: type: string source: enum: - "" - censys - recog - wappalyzer - third_party - html_meta_extractor type: string tactic: items: type: string type: - array - "null" type: items: type: string type: - array - "null" type: object ThreatListItem: additionalProperties: false properties: added_at: description: The date and time when the threat was added. format: date-time type: string count: description: Total count of assets affected by this threat. format: int64 type: integer description: description: Detailed description of the threat. type: string host_count: description: Number of hosts affected by this threat. format: int64 type: integer id: description: Unique identifier of the threat. type: string name: description: Human-readable name of the threat. type: string references: description: External reference links for the threat. items: $ref: "#/components/schemas/ThreatReference" type: - array - "null" web_count: description: Number of web properties affected by this threat. format: int64 type: integer required: - id - count - host_count - web_count type: object ThreatOnHostRange: additionalProperties: false properties: end_time: description: When the threat was last observed format: date-time type: string ip: description: IP address where the threat was observed type: string port: description: Port number where the threat was observed type: string protocol: description: Application protocol (e.g., HTTP, HTTPS) type: string start_time: description: When the threat was first observed format: date-time type: string threat_name: description: Name of the detected threat type: string transport_protocol: description: Transport protocol (TCP or UDP) type: string required: - threat_name - ip - port - protocol - transport_protocol - start_time - end_time type: object ThreatOnWebRange: additionalProperties: false properties: end_time: description: When the threat was last observed format: date-time type: string start_time: description: When the threat was first observed format: date-time type: string threat_name: description: Name of the detected threat type: string required: - threat_name - start_time - end_time type: object ThreatReference: additionalProperties: false properties: link: description: URL reference link for the threat. type: string required: - link type: object Threat_Actor: additionalProperties: false properties: all_names: items: type: string type: - array - "null" id: type: string malpedia_group_id: type: string mitre_group_id: type: string primary_name: type: string type: object Threat_Details: additionalProperties: false properties: campaign_id: type: string campaign_theme: type: string control_servers: items: type: string type: - array - "null" version: type: string type: object Threat_Malware: additionalProperties: false properties: all_names: items: type: string type: - array - "null" id: type: string last_updated_at: type: string malpedia_id: type: string primary_name: type: string type: object ThreatsListResponse: additionalProperties: false properties: threats: description: List of active threats observed on the platform. items: $ref: "#/components/schemas/ThreatListItem" type: - array - "null" required: - threats type: object ThreatsOnHostResponse: additionalProperties: false properties: NextPageToken: type: string Ranges: items: $ref: "#/components/schemas/ThreatOnHostRange" type: - array - "null" required: - Ranges - NextPageToken type: object ThreatsOnWebResponse: additionalProperties: false properties: NextPageToken: type: string Ranges: items: $ref: "#/components/schemas/ThreatOnWebRange" type: - array - "null" required: - Ranges - NextPageToken type: object Tibia: additionalProperties: false properties: client_version: type: string location: type: string login_ip: type: string login_port: type: string name: type: string server: type: string url: type: string version: type: string type: object Tls: additionalProperties: false properties: cipher_selected: description: Cipher suite chosen for the exchange. type: string fingerprint_sha256: description: The SHA-256 digest of the entire raw certificate. Its unique identifier, which Censys uses to index certificates records. format: hex type: string ja3s: description: The JA3S fingerprint for this service. format: hex type: string ja4s: type: string presented_chain: description: Certificate chain information. items: $ref: "#/components/schemas/Tls_Chain" type: - array - "null" version_selected: description: Certificate version v1(0), v2(1), v3(2). enum: - "" - ss_lv_2 - ss_lv_3 - tlsv1_0 - tlsv1_1 - tlsv1_2 - tlsv1_3 - dtlsv1_0 - dtlsv1_2 - dtlsv1_3 type: string versions: items: $ref: "#/components/schemas/Tls_VersionData" type: - array - "null" type: object Tls_Chain: additionalProperties: false properties: fingerprint_sha256: description: SHA 256 fingerprint of the certificate in the certificate chain. format: hex type: string issuer_dn: description: Distinguished name of the entity that has signed and issued the certificate. type: string subject_dn: description: Distinguished name of the entity that the certificate belongs to. type: string type: object Tls_VersionData: additionalProperties: false properties: ja3s: format: hex type: string ja4s: type: string version: enum: - "" - ss_lv_2 - ss_lv_3 - tlsv1_0 - tlsv1_1 - tlsv1_2 - tlsv1_3 - dtlsv1_0 - dtlsv1_2 - dtlsv1_3 type: string type: object TorServiceDescriptor: additionalProperties: false properties: algorithm_name: type: string hash: format: hex type: string hash_bits: format: int32 type: integer onion: type: string type: object TplinkKasa: additionalProperties: false properties: active_mode: type: string brightness: format: int64 type: integer dev_name: type: string err_code: format: int64 type: integer feature: type: string hw_ver: type: string icon_hash: type: string led_off: format: int64 type: integer mic_type: type: string model: type: string on_time: format: int64 type: integer relay_state: format: int64 type: integer rssi: format: int64 type: integer sw_ver: type: string updating: format: int64 type: integer type: object TrackedScan: additionalProperties: false properties: completed: type: boolean create_time: type: string target: $ref: "#/components/schemas/TrackedScan_ScanTarget" tasks: items: $ref: "#/components/schemas/TrackedScan_Task" type: - array - "null" tracked_scan_id: type: string type: object TrackedScan_ScanTarget: additionalProperties: false properties: host_port: $ref: "#/components/schemas/TrackedScan_ScanTarget_HostPort" hostname_port: $ref: "#/components/schemas/TrackedScan_ScanTarget_HostnamePort" service_id: $ref: "#/components/schemas/ServiceId" web_origin: $ref: "#/components/schemas/WebOrigin" type: object TrackedScan_ScanTarget_HostPort: additionalProperties: false properties: ip: type: string port: format: int32 minimum: 0 type: integer type: object TrackedScan_ScanTarget_HostnamePort: additionalProperties: false properties: hostname: type: string port: format: int32 minimum: 0 type: integer type: object TrackedScan_Task: additionalProperties: false properties: description: type: string status: enum: - "" - scanning - scanned - rejected - timed_out - completed - ignored type: string update_time: type: string type: object UnitronicsPcom: additionalProperties: false properties: buffer_size: type: string hardware_version: type: string model: type: string model_executor: type: string model_op_executor: type: string name: type: string os_build: type: string os_version: type: string unique_id: format: int64 type: integer unit_id: type: string type: object UnrecognizedPublicKey: additionalProperties: false properties: raw: format: hex type: string type: object UpdateCommentInputBody: additionalProperties: false properties: body: description: The updated comment body text. maxLength: 10000 minLength: 1 type: string required: - body type: object UpdateMemberRoleInputBody: additionalProperties: false properties: roles: description: Array of role identifiers to assign to the user items: enum: - admin - api_access type: string minItems: 0 type: - array - "null" required: - roles type: object UpdateTagInputBody: additionalProperties: false properties: description: description: New description. maxLength: 1000 type: string name: description: New display name. Must be unique within the organization. maxLength: 255 minLength: 1 type: string privacy: description: Tag visibility and management settings. `private` tags are only visible to and editable by organization admins. `shared` tags are visible to and editable by all organization members. enum: - private - shared type: string type: object Upnp: additionalProperties: false properties: devices: items: $ref: "#/components/schemas/Upnp_Device" type: - array - "null" endpoint: type: string headers: additionalProperties: $ref: "#/components/schemas/Http_RepeatedHeaders" type: object spec: $ref: "#/components/schemas/Upnp_SpecVersion" type: object Upnp_Device: additionalProperties: false properties: device_type: type: string friendly_name: type: string id: description: Censys-generated IDs representing a device tree format: int32 type: integer manufacturer: type: string manufacturer_url: type: string model_description: type: string model_name: type: string model_number: type: string model_url: type: string parent_id: format: int32 type: integer presentation_url: type: string serial_number: type: string service_list: items: $ref: "#/components/schemas/Upnp_Service" type: - array - "null" udn: type: string upc: type: string type: object Upnp_Service: additionalProperties: false properties: control_url: type: string event_sub_url: type: string scpd_url: type: string service_id: type: string service_type: type: string type: object Upnp_SpecVersion: additionalProperties: false properties: major: type: string minor: type: string type: object User: additionalProperties: false properties: auth_key_id: type: string steamid: type: string type: object UserCredits: additionalProperties: false properties: balance: description: The current credit balance for the user. format: int64 type: integer resets_at: description: The date that the user's credits will be reset. format: date-time type: string required: - balance type: object UserNotice: additionalProperties: false properties: explicit_text: type: string notice_reference: $ref: "#/components/schemas/NoticeReference" type: object Validation: additionalProperties: false properties: apple: $ref: "#/components/schemas/RootStore" description: A record containing validation information about the certificate from the Apple root store. chrome: $ref: "#/components/schemas/RootStore" description: A record containing validation information about the certificate from the Chrome root store. microsoft: $ref: "#/components/schemas/RootStore" description: A record containing validation information about the certificate from the Microsoft root store. nss: $ref: "#/components/schemas/RootStore" description: A record containing validation information about the certificate from the Mozilla NSS root store. type: object ValidityPeriod: additionalProperties: false properties: length_seconds: description: The duration of the certificate's validity period, in seconds. format: int64 type: integer not_after: description: An RFC-3339-formatted timestamp after which the certificate is no longer valid. type: string not_before: description: An RFC-3339-formatted timestamp before which the certificate is not valid. type: string type: object ValueCountsResponse: additionalProperties: false properties: and_count_results: items: format: double type: number type: - array - "null" required: - and_count_results type: object Ventrilo: additionalProperties: false properties: attributes: items: type: string type: - array - "null" messages: items: $ref: "#/components/schemas/Ventrilo_Message" type: - array - "null" type: object Ventrilo_Header: additionalProperties: false properties: cmd: format: int32 minimum: 0 type: integer data_key: format: int32 minimum: 0 type: integer header_key: format: int32 minimum: 0 type: integer id: format: int32 minimum: 0 type: integer total_length: format: int32 minimum: 0 type: integer type: object Ventrilo_Message: additionalProperties: false properties: body: format: base64 type: string error: type: string header: $ref: "#/components/schemas/Ventrilo_Header" type: object Vnc: additionalProperties: false properties: connection_failed_reason: description: If server terminates handshake, the reason offered (if any) format: utf8 type: string desktop_name: description: Desktop name provided by the server, capped at 255 bytes format: utf8 type: string pixel_encoding: $ref: "#/components/schemas/Vnc_KeyValue" screen_info: $ref: "#/components/schemas/DesktopInfo" security_types: description: server-specified security options items: $ref: "#/components/schemas/Vnc_KeyValue" type: - array - "null" version: format: hex type: string type: object Vnc_KeyValue: additionalProperties: false properties: name: format: utf8 type: string value: format: int32 type: integer type: object Vuln: additionalProperties: false properties: confidence: format: double type: number cwes: items: $ref: "#/components/schemas/CWE" type: - array - "null" evidence: items: $ref: "#/components/schemas/Evidence" type: - array - "null" id: type: string kev: items: $ref: "#/components/schemas/KEV" type: - array - "null" metrics: $ref: "#/components/schemas/Metrics" name: type: string risk_source: enum: - "" - censys - cve type: string severity: enum: - "" - low - medium - high - critical type: string source: enum: - "" - censys - recog - wappalyzer - third_party - html_meta_extractor type: string year: format: int32 minimum: 0 type: integer type: object WebOrigin: additionalProperties: false properties: hostname: type: string port: format: int32 minimum: 0 type: integer type: object WeblogicT3: additionalProperties: false properties: error: type: string error_message: type: string weblogic_version: type: string type: object Webproperty: additionalProperties: false properties: cert: $ref: "#/components/schemas/Certificate" endpoints: items: $ref: "#/components/schemas/EndpointScanState" type: - array - "null" exposures: items: $ref: "#/components/schemas/Risk" type: - array - "null" hardware: items: $ref: "#/components/schemas/Attribute" type: - array - "null" hostname: type: string jarm: $ref: "#/components/schemas/JarmScan" labels: items: $ref: "#/components/schemas/Label" type: - array - "null" misconfigs: items: $ref: "#/components/schemas/Risk" type: - array - "null" operating_systems: items: $ref: "#/components/schemas/Attribute" type: - array - "null" port: format: int32 minimum: 0 type: integer scan_time: type: string software: items: $ref: "#/components/schemas/Attribute" type: - array - "null" threats: items: $ref: "#/components/schemas/Threat" type: - array - "null" tls: $ref: "#/components/schemas/Tls" vulns: items: $ref: "#/components/schemas/Vuln" type: - array - "null" type: object WebpropertyAsset: additionalProperties: false properties: extensions: additionalProperties: {} type: object resource: $ref: "#/components/schemas/Webproperty" required: - resource - extensions type: object Whois: additionalProperties: false properties: network: $ref: "#/components/schemas/Network" organization: $ref: "#/components/schemas/Organization" type: object WhoisUpdated: additionalProperties: false properties: diff: additionalProperties: $ref: "#/components/schemas/FieldDiff" type: object whois: $ref: "#/components/schemas/Whois" type: object Winrm: additionalProperties: false properties: auth_types: items: type: string type: - array - "null" ntlm_info: $ref: "#/components/schemas/NtlmInfo" type: object Worker: additionalProperties: false properties: client_id: type: string fd: type: string functions: type: string ip: type: string type: object WsDiscovery: additionalProperties: false properties: addresses: items: type: string type: - array - "null" metadata_version: format: int32 minimum: 0 type: integer scopes: items: type: string type: - array - "null" types: items: type: string type: - array - "null" type: object X11: additionalProperties: false properties: refusal_reason: type: string requires_authentication: type: boolean vendor: type: string version: type: string type: object ZLint: additionalProperties: false properties: errors_present: description: Whether the certificate's attributes triggered any error lints for non-conformance to the X.509 standard. type: boolean failed_lints: description: A list of lint names which failed, if applicable. items: type: string type: - array - "null" fatals_present: description: Whether the certificate's attributes triggered any fatal lints for non-conformance to the X.509 standard. type: boolean notices_present: description: Whether the certificate's attributes triggered any notice lints for non-conformance to the X.509 standard. type: boolean timestamp: description: An RFC-3339-formated timestamp indicating when the certificate was linted. type: string version: description: The version of Zlint used to lint the certificate. format: int64 type: integer warnings_present: description: Whether the certificate's attributes triggered any warning lints for non-conformance to the X.509 standard. type: boolean type: object Zeromq: additionalProperties: false properties: greeting: $ref: "#/components/schemas/Zeromq_Greeting" handshake: $ref: "#/components/schemas/Zeromq_Handshake" subscription_data: format: hex type: string subscription_match: additionalProperties: type: boolean type: object type: object Zeromq_Greeting: additionalProperties: false properties: as_server: type: boolean mechanism: format: hex type: string signature: format: hex type: string version_major: format: int32 minimum: 0 type: integer version_minor: format: int32 minimum: 0 type: integer type: object Zeromq_Handshake: additionalProperties: false properties: raw: format: hex type: string ready: type: boolean socket_type: type: string type: object securitySchemes: PersonalAccessToken: description: Your Censys personal access token. These are managed in your [Account Settings](https://accounts.censys.io/settings/personal-access-tokens) scheme: bearer type: http info: contact: email: support@censys.com name: Censys Inc. url: https://censys.com title: Censys Platform API version: 1.0.103 openapi: 3.1.0 paths: /v1/supplychains: get: description: Returns a paginated list of supply chain IDs for the organization.<br><br>This endpoint does not cost credits to execute. operationId: v1-supply-chain-list-supply-chains parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Maximum number of supply chains to return per page. explode: false in: query name: page_size schema: default: 100 description: Maximum number of supply chains to return per page. format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from a previous response to retrieve the next page of results. explode: false in: query name: page_token schema: description: Pagination token from a previous response to retrieve the next page of results. type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeSupplyChainsListPayload" description: Supply chains listed successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid arguments "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Conflict "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid inputs "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys List Supply Chains tags: - Supply Chain Intelligence x-speakeasy-ignore: true x-speakeasy-name-override: ListSupplyChains x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/supplychains/suppliers: get: description: Search for suppliers by display name keywords. Results are capped and not paginated.<br><br>This endpoint does not cost credits to execute. operationId: v1-supply-chain-search-suppliers parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Search keywords matched against supplier display names. example: Anthropic explode: false in: query name: keywords schema: description: Search keywords matched against supplier display names. examples: - Anthropic type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeSupplyChainSearchSuppliersPayload" description: Suppliers found successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid arguments "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Conflict "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid inputs "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Search Suppliers tags: - Supply Chain Intelligence x-speakeasy-ignore: true x-speakeasy-name-override: SearchSuppliers x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Add a list of suppliers to the specific supply chain. operationId: v1-supply-chain-add-suppliers parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/SupplyChainAddSuppliersBody" required: true responses: "201": description: Suppliers Added To supply chain successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Supplier/supply chain not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid Inputs "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Adds Supplier to Supply Chain tags: - Supply Chain Intelligence x-speakeasy-ignore: true x-speakeasy-name-override: AddSuppliers x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/supplychains/suppliers/{supplier_id}: delete: description: Remove a supplier from the specified supply chain. operationId: v1-supply-chain-remove-supplier parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID of a Censys supplier to remove from the given supply chain. example: 11111111-2222-3333-4444-555555555555 in: path name: supplier_id required: true schema: description: The ID of a Censys supplier to remove from the given supply chain. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: The ID of a Censys supply chain. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: supply_chain_id required: true schema: description: The ID of a Censys supply chain. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string responses: "204": description: Supplier removed from supply chain successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Supplier or supply chain not found "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid inputs "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Remove a Supplier from a Supply Chain tags: - Supply Chain Intelligence x-speakeasy-ignore: true x-speakeasy-name-override: RemoveSupplier x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/organizations/{organization_id}: get: description: Retrieve an organization's details, including the count of organization members broken down by role and organization settings such as AI training and MFA requirements.<br><br>This endpoint does not cost any credits to execute. operationId: v3-accountmanagement-org-details parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: Whether to include how many members are in this organization, split by role. explode: false in: query name: include_member_counts schema: default: false description: Whether to include how many members are in this organization, split by role. type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeOrganizationDetails" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Organization not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid organization ID "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Organization Details tags: - Account Management x-speakeasy-name-override: GetOrganizationDetails x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/organizations/{organization_id}/audit-log-events: get: description: Retrieve audit log events for an organization. Use query parameters to filter events by time range, user, and event type.<br><br>This endpoint does not cost any credits to execute. operationId: v3-accountmanagement-org-audit-log-events parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: Amount of events to return per page. example: 1 explode: false in: query name: page_size schema: default: 10 description: Amount of events to return per page. examples: - 1 format: int32 maximum: 100 minimum: 1 type: integer - description: Page token for the requested page of audit log events. explode: false in: query name: page_token schema: description: Page token for the requested page of audit log events. type: string - description: Only return events that occurred after this time. This value must be on or after 2026-01-01T00:00:00Z. If not provided, will default to the earliest possible date. example: "2026-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Only return events that occurred after this time. This value must be on or after 2026-01-01T00:00:00Z. If not provided, will default to the earliest possible date. examples: - "2026-01-01T00:00:00Z" format: date-time type: string - description: Only return events that occurred before this time. This value must not be in the future. If not provided, it defaults to the current time. example: "2026-02-01T00:00:00Z" explode: false in: query name: end_time schema: description: Only return events that occurred before this time. This value must not be in the future. If not provided, it defaults to the current time. examples: - "2026-02-01T00:00:00Z" format: date-time type: string - description: Only return events of this type. This field is deprecated and will be removed in a future version. Use event_types instead. explode: false in: query name: event_type schema: deprecated: true description: Only return events of this type. This field is deprecated and will be removed in a future version. Use event_types instead. enum: - user_created - user_login - user_login_failed - user_password_changed - user_password_reset - user_mfa_changed - user_settings_changed - user_enabled - user_disabled - invitation_created - invitation_resent - invitation_accepted - invitation_deleted - membership_created - membership_updated - membership_removed - org_created - org_updated - org_deleted - saml_config_created - saml_config_updated - saml_config_deleted - saml_config_domain_verified - pat_created - pat_deleted - global_data_search_executed - global_data_lookup_executed - global_data_aggregation_executed - asm_seed_created - asm_seed_deleted - asm_exclude_created - asm_exclude_deleted - asm_risk_instance_severity_changed - asm_risk_instance_accepted - asm_risk_instance_unaccepted - asm_risk_type_severity_changed - asm_risk_type_enabled - asm_risk_type_disabled - asm_risk_type_default_enabled - tag_created - tag_updated - tag_deleted - tag_assigned - tag_unassigned - tag_bulk_operation_started - tag_bulk_operation_completed - tag_bulk_operation_cancelled - comment_created - comment_updated - comment_deleted type: string - description: Only return events of these types. example: - user_login - pat_created explode: false in: query name: event_types schema: description: Only return events of these types. examples: - - user_login - pat_created items: enum: - user_created - user_login - user_login_failed - user_password_changed - user_password_reset - user_mfa_changed - user_settings_changed - user_enabled - user_disabled - invitation_created - invitation_resent - invitation_accepted - invitation_deleted - membership_created - membership_updated - membership_removed - org_created - org_updated - org_deleted - saml_config_created - saml_config_updated - saml_config_deleted - saml_config_domain_verified - pat_created - pat_deleted - global_data_search_executed - global_data_lookup_executed - global_data_aggregation_executed - asm_seed_created - asm_seed_deleted - asm_exclude_created - asm_exclude_deleted - asm_risk_instance_severity_changed - asm_risk_instance_accepted - asm_risk_instance_unaccepted - asm_risk_type_severity_changed - asm_risk_type_enabled - asm_risk_type_disabled - asm_risk_type_default_enabled - tag_created - tag_updated - tag_deleted - tag_assigned - tag_unassigned - tag_bulk_operation_started - tag_bulk_operation_completed - tag_bulk_operation_cancelled - comment_created - comment_updated - comment_deleted type: string maxItems: 10 type: - array - "null" - description: Exclude events of these types. example: - user_login - pat_created explode: false in: query name: exclude_event_types schema: description: Exclude events of these types. examples: - - user_login - pat_created items: enum: - user_created - user_login - user_login_failed - user_password_changed - user_password_reset - user_mfa_changed - user_settings_changed - user_enabled - user_disabled - invitation_created - invitation_resent - invitation_accepted - invitation_deleted - membership_created - membership_updated - membership_removed - org_created - org_updated - org_deleted - saml_config_created - saml_config_updated - saml_config_deleted - saml_config_domain_verified - pat_created - pat_deleted - global_data_search_executed - global_data_lookup_executed - global_data_aggregation_executed - asm_seed_created - asm_seed_deleted - asm_exclude_created - asm_exclude_deleted - asm_risk_instance_severity_changed - asm_risk_instance_accepted - asm_risk_instance_unaccepted - asm_risk_type_severity_changed - asm_risk_type_enabled - asm_risk_type_disabled - asm_risk_type_default_enabled - tag_created - tag_updated - tag_deleted - tag_assigned - tag_unassigned - tag_bulk_operation_started - tag_bulk_operation_completed - tag_bulk_operation_cancelled - comment_created - comment_updated - comment_deleted type: string maxItems: 10 type: - array - "null" - description: Only return events performed by this user. example: user@example.com explode: false in: query name: user_email schema: description: Only return events performed by this user. examples: - user@example.com type: string - description: Order events by this field. explode: false in: query name: order_by schema: default: timestamp_desc description: Order events by this field. enum: - timestamp_desc - timestamp_asc type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeAuditLogEventsResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid request parameters "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys List Audit Log Events tags: - Account Management x-speakeasy-ignore: true x-speakeasy-name-override: GetOrganizationAuditLogEvents x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/organizations/{organization_id}/credits: get: description: Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they are acquired.<br><br>This endpoint does not cost any credits to execute. operationId: v3-accountmanagement-org-credits parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeOrganizationCredits" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Organization not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid organization ID "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Organization Credit Balance tags: - Account Management x-speakeasy-name-override: GetOrganizationCredits x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/organizations/{organization_id}/credits/usage: get: description: 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. operationId: v3-accountmanagement-org-credits-usage parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01 (the earliest date available for credit usage reports). example: "2025-11-01" explode: false in: query name: date schema: deprecated: true description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01 (the earliest date available for credit usage reports). examples: - "2025-11-01" type: string - description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after 2025-01-01 (the earliest date available for credit usage reports). example: "2025-11-01" explode: false in: query name: start_date schema: description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after 2025-01-01 (the earliest date available for credit usage reports). examples: - "2025-11-01" format: date type: string - description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year). example: "2025-12-01" explode: false in: query name: end_date schema: description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year). examples: - "2025-12-01" format: date type: string - description: Whether to break down credit usage on a daily or monthly basis. example: daily explode: false in: query name: granularity required: true schema: default: daily description: Whether to break down credit usage on a daily or monthly basis. enum: - daily - monthly examples: - daily type: string - description: Whether to include a breakdown of individual users' consumption in the credit usage report. explode: false in: query name: include_consumer_breakdown schema: default: false description: Whether to include a breakdown of individual users' consumption in the credit usage report. type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCreditUsageReport" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid date format "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Organization not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid organization ID or date "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Organization Credit Usage tags: - Account Management x-speakeasy-name-override: GetOrganizationCreditUsage x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/organizations/{organization_id}/invitations: post: description: Invite a user to an organization. The user will receive an email to join the organization. This is equivalent to [adding a new member via the UI](https://docs.censys.com/docs/platform-org-management#invite-members).<br><br>Only users with the Admin role in the provided organization can perform this operation.<br><br>This endpoint does not cost any credits to execute. operationId: v3-accountmanagement-invite-user-to-org parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/InviteMemberInputBody" required: true responses: "201": description: Invitation sent successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission or organization has reached maximum seat capacity "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Organization not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User is already a member of this organization or an invitation already exists "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid email address "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Invite User to Organization tags: - Account Management x-speakeasy-name-override: InviteUserToOrganization x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/organizations/{organization_id}/members: get: description: Retrieve a paginated list of an organization's members and their user details, including their user ID, email, name, creation time, and roles.<br><br>This endpoint does not cost any credits to execute. operationId: v3-accountmanagement-list-org-members parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: Number of members to return per page explode: false in: query name: page_size schema: default: 10 description: Number of members to return per page format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token for retrieving the next page of results explode: false in: query name: page_token schema: description: Pagination token for retrieving the next page of results type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeOrganizationMembersList" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Organization not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys List Organization Members tags: - Account Management x-speakeasy-name-override: ListOrganizationMembers x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/organizations/{organization_id}/members/{user_id}: delete: description: Remove a user from an organization. This is equivalent to [removing a member via the UI](https://docs.censys.com/docs/platform-org-management#remove-members).<br><br>Only users with the Admin role in the provided organization can perform this operation.<br><br>This endpoint does not cost any credits to execute. operationId: v3-accountmanagement-remove-org-member parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization. example: 11111111-2222-3333-4444-555555555555 in: path name: user_id required: true schema: description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string responses: "204": description: Member removed successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Membership or organization not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Cannot remove the last admin from the organization "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid organization ID or user ID "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Remove Member from Organization tags: - Account Management x-speakeasy-name-override: RemoveOrganizationMember x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: description: Update the roles assigned to an organization member. This operation replaces a member's roles with the list provided in the request body. To remove all roles from a member, provide an empty list. To completely remove a member from an organization, use the [remove member endpoint](https://docs.censys.com/reference/v3-accountmanagement-remove-org-member).<br><br>Only users with the Admin role in the provided organization can perform this operation.<br><br>This endpoint does not cost any credits to execute. operationId: v3-accountmanagement-update-org-member parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization. example: 11111111-2222-3333-4444-555555555555 in: path name: user_id required: true schema: description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateMemberRoleInputBody" required: true responses: "204": description: Organization member updated successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid role identifiers or user/organization ID "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User, organization, or membership not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Conflict "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid organization ID or user ID "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Update a Member's Roles in an Organization tags: - Account Management x-speakeasy-name-override: UpdateOrganizationMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/organizations/{organization_id}/members/{user_id}/credits/usage: get: description: 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. operationId: v3-accountmanagement-member-credits-usage parameters: - description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 in: path name: organization_id required: true schema: description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization. example: 11111111-2222-3333-4444-555555555555 in: path name: user_id required: true schema: description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01 (the earliest date available for credit usage reports). example: "2025-11-01" explode: false in: query name: date schema: deprecated: true description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01 (the earliest date available for credit usage reports). examples: - "2025-11-01" type: string - description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after 2025-01-01 (the earliest date available for credit usage reports). example: "2025-11-01" explode: false in: query name: start_date schema: description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after 2025-01-01 (the earliest date available for credit usage reports). examples: - "2025-11-01" format: date type: string - description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year). example: "2025-12-01" explode: false in: query name: end_date schema: description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year). examples: - "2025-12-01" format: date type: string - description: Whether to break down credit usage on a daily or monthly basis. example: daily explode: false in: query name: granularity required: true schema: default: daily description: Whether to break down credit usage on a daily or monthly basis. enum: - daily - monthly examples: - daily type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCreditUsageReport" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid date format "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Organization not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid user ID or organization ID "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Organization Member Credit Usage tags: - Account Management x-speakeasy-name-override: GetMemberCreditUsage x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/users/credits: get: description: 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. operationId: v3-accountmanagement-user-credits responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeUserCredits" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Free User Credit Balance tags: - Account Management x-speakeasy-name-override: GetUserCredits x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/accounts/users/credits/usage: get: description: 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. operationId: v3-accountmanagement-user-credits-usage parameters: - description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01 (the earliest date available for credit usage reports). example: "2025-11-01" explode: false in: query name: date schema: deprecated: true description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01 (the earliest date available for credit usage reports). examples: - "2025-11-01" type: string - description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after 2025-01-01 (the earliest date available for credit usage reports). example: "2025-11-01" explode: false in: query name: start_date schema: description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after 2025-01-01 (the earliest date available for credit usage reports). examples: - "2025-11-01" format: date type: string - description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year). example: "2025-12-01" explode: false in: query name: end_date schema: description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year). examples: - "2025-12-01" format: date type: string - description: Whether to break down credit usage on a daily or monthly basis. example: daily explode: false in: query name: granularity required: true schema: default: daily description: Whether to break down credit usage on a daily or monthly basis. enum: - daily - monthly examples: - daily type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCreditUsageReport" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Free User Credit Usage tags: - Account Management x-speakeasy-name-override: GetUserCreditsUsage x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/collections: get: description: 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. operationId: v3-collections-crud-list parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: page token for the requested page of collection results explode: false in: query name: page_token schema: description: page token for the requested page of collection results type: string - description: amount of results to return per page example: 1 explode: false in: query name: page_size schema: description: amount of results to return per page examples: - 1 format: int64 minimum: 0 type: integer - description: statuses of collection for results to be filtered on. example: - populating - active explode: false in: query name: collection_statuses schema: description: statuses of collection for results to be filtered on. examples: - - populating - active items: enum: - populating - active - paused - archived type: string maxItems: 4 type: - array - "null" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeListCollectionsResponseV1" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys List Collections tags: - Collections x-speakeasy-name-override: List x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Create a new collection.<br><br>This endpoint does not cost credits to execute. operationId: v3-collections-crud-create parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/CrudCreateInputBody" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCollection" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Conflict "412": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Collection limit exceeded "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Create a Collection tags: - Collections x-speakeasy-name-override: Create x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/collections/{collection_uid}: delete: description: Delete a collection.<br><br>This endpoint does not cost credits to execute. operationId: v3-collections-crud-delete parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console. example: 11111111-2222-3333-4444-555555555555 in: path name: collection_uid required: true schema: description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string responses: "204": description: Empty response body when the deletion is successful headers: X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No collection found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Delete a Collection tags: - Collections x-speakeasy-name-override: Delete x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 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. operationId: v3-collections-crud-get parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console. example: 11111111-2222-3333-4444-555555555555 in: path name: collection_uid required: true schema: description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCollection" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No collection found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get a Collection tags: - Collections x-speakeasy-name-override: Get x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute. operationId: v3-collections-crud-update parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The UID for the collection example: 11111111-2222-3333-4444-555555555555 in: path name: collection_uid required: true schema: description: The UID for the collection examples: - 11111111-2222-3333-4444-555555555555 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CrudUpdateInputBody" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCollection" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No collection found "412": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Collection is paused or archived "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Update a Collection tags: - Collections x-speakeasy-name-override: Update x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/collections/{collection_uid}/events: get: description: 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. operationId: v3-collections-list-events parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console. example: 11111111-2222-3333-4444-555555555555 in: path name: collection_uid required: true schema: description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: Amount of results to return per page. example: 1 explode: false in: query name: page_size schema: description: Amount of results to return per page. examples: - 1 format: int32 minimum: 0 type: integer - description: Page token for the requested page of collection results. explode: false in: query name: page_token schema: description: Page token for the requested page of collection results. type: string - description: Change types explode: false in: query name: change_types schema: description: Change types items: enum: - asset - status type: string type: - array - "null" - description: Asset change types explode: false in: query name: asset_change_types schema: description: Asset change types items: enum: - added - removed type: string type: - array - "null" - description: Status change types explode: false in: query name: status_change_types schema: description: Status change types items: enum: - active - archived - paused - populating type: string type: - array - "null" - description: Start time of the host timeline example: "2025-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start time of the host timeline examples: - "2025-01-01T00:00:00Z" format: date-time type: string - description: End time of the host timeline example: "2025-01-02T00:00:00Z" explode: false in: query name: end_time schema: description: End time of the host timeline examples: - "2025-01-02T00:00:00Z" format: date-time type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCollectionEventsResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No collection found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get a Collection's Events tags: - Collections x-speakeasy-name-override: ListEvents x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/collections/{collection_uid}/search/aggregate: post: description: Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI. operationId: v3-collections-search-aggregate parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console. example: 11111111-2222-3333-4444-555555555555 in: path name: collection_uid required: true schema: description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchAggregateInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeSearchAggregateResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No collection found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Aggregate Results for a Search Query Within a Collection tags: - Collections x-speakeasy-name-override: Aggregate x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/collections/{collection_uid}/search/query: post: description: Run a search query across a collection's assets. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax. Host services that match your search criteria will be returned in a `matched_services` object. operationId: v3-collections-search-query parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The UID for the collection in: path name: collection_uid required: true schema: description: The UID for the collection type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchQueryInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeSearchQueryResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No collection found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Run a Search Query Within a Collection tags: - Collections x-speakeasy-name-override: Search x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/comments: get: description: Retrieve a paginated list of comments in your organization. Use query parameters to filter by asset, creator, or creation time.<br><br>This endpoint does not cost any credits to execute. operationId: v3-comments-list-comments parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Number of comments to return per page. explode: false in: query name: page_size schema: default: 100 description: Number of comments to return per page. format: int32 maximum: 1000 minimum: 1 type: integer - description: Pagination token from a previous response to retrieve the next page of results. explode: false in: query name: page_token schema: description: Pagination token from a previous response to retrieve the next page of results. type: string - description: "Sort order. Supported values: create_time_asc, create_time_desc." explode: false in: query name: order_by schema: default: create_time_desc description: "Sort order. Supported values: create_time_asc, create_time_desc." enum: - create_time_asc - create_time_desc type: string - description: Filter comments by asset identifier (host IP, certificate fingerprint, or web property hostname:port). explode: false in: query name: asset_id schema: description: Filter comments by asset identifier (host IP, certificate fingerprint, or web property hostname:port). type: string - description: Filter comments by the user ID of the user who created the comment. explode: false in: query name: created_by schema: description: Filter comments by the user ID of the user who created the comment. format: uuid type: string - description: Filter comments created before this RFC3339 timestamp. explode: false in: query name: created_before schema: description: Filter comments created before this RFC3339 timestamp. format: date-time type: string - description: Filter comments created after this RFC3339 timestamp. explode: false in: query name: created_after schema: description: Filter comments created after this RFC3339 timestamp. format: date-time type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCommentsList" description: Comments retrieved successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys List Comments tags: - Tags and Comments x-speakeasy-name-override: ListComments x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Add a comment on an asset in your organization.<br><br>This endpoint does not cost any credits to execute. operationId: v3-comments-create-comment parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateCommentInputBody" required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeComment" description: Comment created successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Create a Comment tags: - Tags and Comments x-speakeasy-name-override: CreateComment x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/comments/{comment_id}: delete: description: Delete a comment. Only the comment's creator or an organization admin can delete a comment. This action is permanent and cannot be undone.<br><br>This endpoint does not cost any credits to execute. operationId: v3-comments-delete-comment parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID of the comment to delete. in: path name: comment_id required: true schema: description: The ID of the comment to delete. format: uuid type: string responses: "204": description: Comment deleted successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Comment not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Delete a Comment tags: - Tags and Comments x-speakeasy-name-override: DeleteComment x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Update the body of an existing comment. Only the comment's creator can update it.<br><br>This endpoint does not cost any credits to execute. operationId: v3-comments-update-comment parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID of the comment to update. in: path name: comment_id required: true schema: description: The ID of the comment to update. format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateCommentInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeComment" description: Comment updated successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Comment not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Update a Comment tags: - Tags and Comments x-speakeasy-name-override: UpdateComment x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/certificate: get: deprecated: true description: Retrieve information about multiple certificates. A certificate ID is its SHA-256 fingerprint in the Censys dataset.<br><br>The GET method of this endpoint is deprecated, but will continue to be supported for backwards compatibility. Please use the [POST variant](https://docs.censys.com/reference/v3-globaldata-asset-certificate-list-post#/) of this endpoint instead. operationId: v3-globaldata-asset-certificate-list parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: A list of SHA-256 certificate fingerprints. example: - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf explode: false in: query name: certificate_ids required: true schema: description: A list of SHA-256 certificate fingerprints. examples: - - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf items: type: string maxItems: 1000 minItems: 1 type: - array - "null" responses: "200": content: application/vnd.censys.api.v3.certificate.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeListCertificateAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No certificates found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Retrieve Multiple Certificates tags: - Global Data x-speakeasy-ignore: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Retrieve information about multiple certificates. You can retrieve up to 1,000 certificates per call. A certificate ID is its SHA-256 fingerprint in the Censys dataset. operationId: v3-globaldata-asset-certificate-list-post parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/AssetCertificateListInputBody" required: true responses: "200": content: application/vnd.censys.api.v3.certificate.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeListCertificateAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No certificates found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Retrieve Multiple Certificates tags: - Global Data x-speakeasy-name-override: GetCertificates x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/certificate/raw: get: deprecated: true description: Retrieve the raw PEM-encoded format for multiple certificates. A certificate ID is its SHA-256 fingerprint in the Censys dataset.<br><br>The GET method of this endpoint is deprecated, but will continue to be supported for backwards compatibility. Please use the [POST variant](https://docs.censys.com/reference/v3-globaldata-asset-certificate-list-raw-post#/) of this endpoint instead. operationId: v3-globaldata-asset-certificate-list-raw parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: A list of SHA-256 certificate fingerprints. example: - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf explode: false in: query name: certificate_ids required: true schema: description: A list of SHA-256 certificate fingerprints. examples: - - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf items: type: string maxItems: 1000 minItems: 1 type: - array - "null" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeListRawCertificateResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No certificates found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Retrieve Multiple Certificates in PEM Format tags: - Global Data x-speakeasy-ignore: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Retrieve the raw PEM-encoded format for multiple certificates. You can retrieve up to 1,000 certificates per call. A certificate ID is its SHA-256 fingerprint in the Censys dataset. operationId: v3-globaldata-asset-certificate-list-raw-post parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/AssetCertificateListInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeListRawCertificateResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No certificates found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Retrieve Multiple Certificates in PEM Format tags: - Global Data x-speakeasy-name-override: GetCertificatesRaw x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/certificate/{certificate_id}: get: description: Retrieve information about a single certificate. A certificate ID is its SHA-256 fingerprint in the Censys dataset. operationId: v3-globaldata-asset-certificate parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The SHA-256 certificate fingerprint. example: 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf in: path name: certificate_id required: true schema: description: The SHA-256 certificate fingerprint. examples: - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf type: string responses: "200": content: application/vnd.censys.api.v3.certificate.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeCertificateAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No certificate found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get a Certificate tags: - Global Data x-speakeasy-name-override: GetCertificate x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/certificate/{certificate_id}/raw: get: description: Retrieve the raw PEM-encoded format of a certificate. A certificate ID is its SHA-256 fingerprint in the Censys dataset. operationId: v3-globaldata-asset-certificate-raw parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The SHA-256 certificate fingerprint. example: 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf in: path name: certificate_id required: true schema: description: The SHA-256 certificate fingerprint. examples: - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf type: string responses: "200": content: application/x-pem-file: schema: contentMediaType: application/octet-stream format: binary type: string description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No certificate found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get a Certificate in PEM Format tags: - Global Data x-speakeasy-name-override: GetCertificateRaw x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/host: get: deprecated: true description: Retrieve information about multiple hosts. A host ID is its IP address.<br><br>The GET method of this endpoint is deprecated, but will continue to be supported for backwards compatibility. Please use the [POST variant](https://docs.censys.com/reference/v3-globaldata-asset-host-list-post#/) of this endpoint instead. operationId: v3-globaldata-asset-host-list parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: A list of host IP addresses. example: - 8.8.8.8 explode: false in: query name: host_ids required: true schema: description: A list of host IP addresses. examples: - - 8.8.8.8 items: type: string maxItems: 100 minItems: 1 type: - array - "null" - description: RFC3339 Timestamp to view all requested hosts at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. example: "2025-01-01T00:00:00Z" explode: false in: query name: at_time schema: description: RFC3339 Timestamp to view all requested hosts at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. examples: - "2025-01-01T00:00:00Z" format: date-time type: string responses: "200": content: application/vnd.censys.api.v3.host.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeListHostAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Retrieve Multiple Hosts tags: - Global Data x-speakeasy-ignore: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Retrieve information about multiple hosts. You can retrieve up to 100 hosts per call. A host ID is its IP address. operationId: v3-globaldata-asset-host-list-post parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/AssetHostListInputBody" required: true responses: "200": content: application/vnd.censys.api.v3.host.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeListHostAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Retrieve Multiple Hosts tags: - Global Data x-speakeasy-name-override: GetHosts x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/host/{host_id}: get: description: Retrieve information about a single host. A host ID is its IP address. operationId: v3-globaldata-asset-host parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The IP address of a host. example: 8.8.8.8 in: path name: host_id required: true schema: description: The IP address of a host. examples: - 8.8.8.8 format: ip type: string - description: RFC3339 Timestamp to view a host at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. example: "2025-01-01T00:00:00Z" explode: false in: query name: at_time schema: description: RFC3339 Timestamp to view a host at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. examples: - "2025-01-01T00:00:00Z" format: date-time type: string responses: "200": content: application/vnd.censys.api.v3.host.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeHostAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No host found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get a Host tags: - Global Data x-speakeasy-name-override: GetHost x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/host/{host_id}/observations/services: get: description: Retrieve historical service observations for a host. This endpoint returns time ranges during which services were detected on the host.<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account.<br><br>You can filter by port number, protocol, and transport protocol. operationId: v3-globaldata-service-on-host parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by port number example: 443 explode: false in: query name: port schema: description: Filter by port number examples: - 443 format: int32 type: integer - description: Filter by application protocol example: HTTP explode: false in: query name: protocol schema: description: Filter by application protocol examples: - HTTP type: string - description: Filter by transport protocol example: tcp explode: false in: query name: transport_protocol schema: description: Filter by transport protocol enum: - tcp - udp - quic examples: - tcp type: string - description: The IP address of a host. example: 8.8.8.8 in: path name: host_id required: true schema: description: The IP address of a host. examples: - 8.8.8.8 format: ip type: string - description: Order observations by these fields. Multiple values can be provided to sort by multiple fields (e.g., ['port DESC', 'protocol ASC']). explode: false in: query name: order_by schema: description: Order observations by these fields. Multiple values can be provided to sort by multiple fields (e.g., ['port DESC', 'protocol ASC']). items: enum: - port ASC - port DESC - protocol ASC - protocol DESC - transport_protocol ASC - transport_protocol DESC type: string type: - array - "null" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeServicesOnHostResponse" description: A list of service observation ranges headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Service History for a Host tags: - Global Data x-speakeasy-name-override: ListServicesOnHost x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/host/{host_id}/timeline: get: description: Retrieve event history for a host. A host ID is its IP address.<br><br>Note that when a service protocol changes after a new scan (for example, from `UNKNOWN` to `NETBIOS`), this information will be reflected in the `scan` object. operationId: v3-globaldata-asset-host-timeline parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The IP address of a host. example: 8.8.8.8 in: path name: host_id required: true schema: description: The IP address of a host. examples: - 8.8.8.8 type: string - description: Start time of the host timeline. Equivalent to the To field in the event history UI. This must be the timestamp closest to the current time. For example, if you want events from January 1, 2025 to the start of January 2, 2025, input the January 2 timestamp here. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. example: "2025-01-02T00:00:00Z" explode: false in: query name: start_time required: true schema: description: Start time of the host timeline. Equivalent to the To field in the event history UI. This must be the timestamp closest to the current time. For example, if you want events from January 1, 2025 to the start of January 2, 2025, input the January 2 timestamp here. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. examples: - "2025-01-02T00:00:00Z" format: date-time type: string - description: End time of the host timeline. Equivalent to the From field in the event history UI. This must be the timestamp furthest from the current time. For example, if you want events from January 1, 2025 to the start of January 2, 2025, input the January 1 timestamp here. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. example: "2025-01-01T00:00:00Z" explode: false in: query name: end_time required: true schema: description: End time of the host timeline. Equivalent to the From field in the event history UI. This must be the timestamp furthest from the current time. For example, if you want events from January 1, 2025 to the start of January 2, 2025, input the January 1 timestamp here. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time. examples: - "2025-01-01T00:00:00Z" format: date-time type: string responses: "200": content: application/vnd.censys.api.v3.host_timeline_event.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeHostTimeline" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Host Event History tags: - Global Data x-speakeasy-name-override: GetHostTimeline x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/webproperty: get: deprecated: true description: Retrieve information about multiple web properties. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80`.<br><br>The GET method of this endpoint is deprecated, but will continue to be supported for backwards compatibility. Please use the [POST variant](https://docs.censys.com/reference/v3-globaldata-asset-webproperty-list-post#/) of this endpoint instead. operationId: v3-globaldata-asset-webproperty-list parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: A list of web property identifiers. example: - platform.censys.io:80 explode: false in: query name: webproperty_ids required: true schema: description: A list of web property identifiers. examples: - - platform.censys.io:80 items: type: string maxItems: 100 minItems: 1 type: - array - "null" - description: RFC3339 Timestamp to view all requested webproperties at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time example: "2025-01-01T00:00:00Z" explode: false in: query name: at_time schema: description: RFC3339 Timestamp to view all requested webproperties at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time examples: - "2025-01-01T00:00:00Z" format: date-time type: string responses: "200": content: application/vnd.censys.api.v3.webproperty.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeListWebpropertyAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Retrieve Multiple Web Properties tags: - Global Data x-speakeasy-ignore: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Retrieve information about multiple web properties. You can retrieve up to 100 web properties per call. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80`. operationId: v3-globaldata-asset-webproperty-list-post parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/AssetWebpropertyListInputBody" required: true responses: "200": content: application/vnd.censys.api.v3.webproperty.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeListWebpropertyAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Retrieve Multiple Web Properties tags: - Global Data x-speakeasy-name-override: GetWebProperties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/asset/webproperty/{webproperty_id}: get: description: Retrieve information about a single web property. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80`. operationId: v3-globaldata-asset-webproperty parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: A web property identifier. example: platform.censys.io:80 in: path name: webproperty_id required: true schema: description: A web property identifier. examples: - platform.censys.io:80 type: string - description: RFC3339 Timestamp to view a webproperty at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time example: "2025-01-01T00:00:00Z" explode: false in: query name: at_time schema: description: RFC3339 Timestamp to view a webproperty at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time examples: - "2025-01-01T00:00:00Z" format: date-time type: string responses: "200": content: application/vnd.censys.api.v3.webproperty.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeWebpropertyAsset" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get a Web Property tags: - Global Data x-speakeasy-name-override: GetWebProperty x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/dns/resolutions/ip/{ip}/bounds: get: description: Retrieve the latest domain names that resolved to the IP you provide (A and AAAA). You can narrow results with `record_types` (A or AAAA).<br><br>[Learn more about Censys Active DNS Resolution](https://docs.censys.com/docs/platform-active-dns).<br><br>This endpoint is in beta and is only available to Censys Enterprise users. operationId: v3-globaldata-dns-ip-resolution-bound parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by record types (A, AAAA). For multiple values, include comma-separated values. Defaults to A and AAAA when omitted. example: - A explode: false in: query name: record_types schema: description: Filter by record types (A, AAAA). For multiple values, include comma-separated values. Defaults to A and AAAA when omitted. examples: - - A items: enum: - A - AAAA type: string type: - array - "null" - description: The IP address of a DNS record. example: 8.8.8.8 in: path name: ip required: true schema: description: The IP address of a DNS record. examples: - 8.8.8.8 format: ip type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeDnsIpResolutionBoundResponse" description: A list of domain names that resolved to the provided IP. headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Latest DNS Names That Resolved to an IP tags: - Global Data x-speakeasy-ignore: true x-speakeasy-name-override: ListDnsIpResolutionBounds x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/dns/resolutions/ip/{ip}/ranges: get: description: Retrieve domain names that resolved to the IP you provide (A and AAAA) within the requested time window.<br><br>[Learn more about Censys Active DNS Resolution](https://docs.censys.com/docs/platform-active-dns).<br><br>This endpoint is in beta and is only available to Censys Enterprise users. operationId: v3-globaldata-dns-ip-resolution-ranges parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by record types (A, AAAA). For multiple values, include comma-separated values. Defaults to A and AAAA when omitted. example: - A explode: false in: query name: record_types schema: description: Filter by record types (A, AAAA). For multiple values, include comma-separated values. Defaults to A and AAAA when omitted. examples: - - A items: enum: - A - AAAA type: string type: - array - "null" - description: Filter to a specific domain name resolving to this IP. example: platform.censys.io explode: false in: query name: domain schema: description: Filter to a specific domain name resolving to this IP. examples: - platform.censys.io type: string - description: The IP address of a DNS record. example: 8.8.8.8 in: path name: ip required: true schema: description: The IP address of a DNS record. examples: - 8.8.8.8 format: ip type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeDnsIpResolutionRangeResponse" description: A list of domain names that resolved to the provided IP. headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get DNS Names That Resolved to an IP Within a Time Window tags: - Global Data x-speakeasy-ignore: true x-speakeasy-name-override: ListDnsIpResolutionRanges x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/dns/resolutions/{name}/bounds: get: description: Retrieve the latest DNS resolution records for a name. This endpoint returns the latest observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using `record_types`.<br><br>[Learn more about Censys Active DNS Resolution](https://docs.censys.com/docs/platform-active-dns).<br><br>This endpoint is in beta and is only available to Censys Enterprise users. operationId: v3-globaldata-dns-name-resolution-bound parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by record types (A, AAAA, MX, NS, SOA, TXT). For multiple values, include comma-separated values. Defaults to all supported types when omitted. example: - MX explode: false in: query name: record_types schema: description: Filter by record types (A, AAAA, MX, NS, SOA, TXT). For multiple values, include comma-separated values. Defaults to all supported types when omitted. examples: - - MX items: enum: - A - AAAA - MX - NS - SOA - TXT type: string type: - array - "null" - description: The domain name example: platform.censys.io in: path name: name required: true schema: description: The domain name examples: - platform.censys.io type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeDnsNameResolutionBoundResponse" description: A list of DNS records currently resolving for the provided name. headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Latest DNS Resolution Records for a Name tags: - Global Data x-speakeasy-ignore: true x-speakeasy-name-override: ListDnsNameResolutionBounds x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/dns/resolutions/{name}/ranges: get: description: Retrieve historical DNS resolution observations for a name. Each item is one window during which a record value was observed by Censys.<br><br>[Learn more about Censys Active DNS Resolution](https://docs.censys.com/docs/platform-active-dns).<br><br>This endpoint is in beta and is only available to Censys Enterprise users. operationId: v3-globaldata-dns-name-resolution-ranges parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by record types (A, AAAA, MX, NS, SOA, TXT). For multiple values, include comma-separated values. Defaults to all supported types when omitted. example: - MX explode: false in: query name: record_types schema: description: Filter by record types (A, AAAA, MX, NS, SOA, TXT). For multiple values, include comma-separated values. Defaults to all supported types when omitted. examples: - - MX items: enum: - A - AAAA - MX - NS - SOA - TXT type: string type: - array - "null" - description: The domain name example: platform.censys.io in: path name: name required: true schema: description: The domain name examples: - platform.censys.io type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeDnsNameResolutionRangeResponse" description: A list of DNS resolution observations for the provided name. headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Historical DNS Resolution Ranges for a Name tags: - Global Data x-speakeasy-ignore: true x-speakeasy-name-override: ListDnsNameResolutionRanges x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/scans/rescan: post: description: Initiate a rescan for a known host service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Rescan](https://docs.censys.com/docs/platform-live-rescan#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-globaldata-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. It costs 10 credits to execute. operationId: v3-globaldata-scans-rescan parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/ScansRescanInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeTrackedScan" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: "Censys Live Rescan: Initiate a New Rescan" tags: - Global Data x-speakeasy-name-override: CreateTrackedScan x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/scans/{scan_id}: get: description: Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. This endpoint does not cost any credits to execute. operationId: v3-globaldata-scans-get parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The unique identifier of the tracked scan in: path name: scan_id required: true schema: description: The unique identifier of the tracked scan format: uuid type: string responses: "200": content: application/vnd.censys.api.v3.trackedscan.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeTrackedScan" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No scan found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Scan Status tags: - Global Data x-speakeasy-name-override: GetTrackedScan x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/search/aggregate: post: description: Aggregate results for a Platform search query. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI. operationId: v3-globaldata-search-aggregate parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchAggregateInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeSearchAggregateResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Aggregate Results for a Search Query tags: - Global Data x-speakeasy-name-override: Aggregate x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/search/convert: post: description: Convert Censys Search Language queries used in Legacy Search into Censys Query Language (CenQL) queries for use in the Platform.<br><br>Reference the [documentation on CenQL](https://docs.censys.com/docs/censys-query-language) for more information about query syntax. operationId: v3-globaldata-search-convert parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchConvertQueryInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeListSearchConvertQueryResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Convert Legacy Search Queries to Platform Queries tags: - Global Data x-speakeasy-name-override: ConvertLegacySearchQueries x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/global/search/query: post: description: Run a search query across Censys data. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax. Host services that match your search criteria will be returned in a `matched_services` object. operationId: v3-globaldata-search-query parameters: - description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id schema: description: The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. If omitted, the request will be processed using the authenticated user's free wallet where applicable. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchQueryInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeSearchQueryResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Run a Search Query tags: - Global Data x-speakeasy-name-override: Search x-speakeasy-usage-example: description: "" position: 1 tags: [] title: "" x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/tags: get: description: Retrieve a paginated list of tags in your organization. Private tags created by other users are not included in the results unless your account is an organization admin.<br><br>This endpoint does not cost any credits to execute. operationId: v3-tags-list-tags parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Number of tags to return per page. explode: false in: query name: page_size schema: default: 100 description: Number of tags to return per page. format: int32 maximum: 1000 minimum: 1 type: integer - description: Pagination token from a previous response to retrieve the next page of results. explode: false in: query name: page_token schema: description: Pagination token from a previous response to retrieve the next page of results. type: string - description: "Sort order. Supported values: name_asc, name_desc, created_at_asc, created_at_desc, updated_at_asc, updated_at_desc." explode: false in: query name: order_by schema: default: name_asc description: "Sort order. Supported values: name_asc, name_desc, created_at_asc, created_at_desc, updated_at_asc, updated_at_desc." enum: - name_asc - name_desc - created_at_asc - created_at_desc - updated_at_asc - updated_at_desc type: string - description: Filter tags by name (exact match). explode: false in: query name: name schema: description: Filter tags by name (exact match). type: string - description: Filter tags by the user ID of the user who created the tag. explode: false in: query name: created_by schema: description: Filter tags by the user ID of the user who created the tag. format: uuid type: string - description: Filter tags by privacy setting. explode: false in: query name: privacy schema: description: Filter tags by privacy setting. enum: - private - shared type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeTagsList" description: Tags retrieved successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys List Tags tags: - Tags and Comments x-speakeasy-name-override: ListTags x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: "Create a new tag in your organization. Tags can be used to label and organize assets.<br><br>Specify a privacy setting to control visibility: `private` tags are only visible to you and organization admins, while `shared` tags are visible and manageable by all organization members.<br><br>Tag names must be unique within your organization.<br><br>This endpoint does not cost any credits to execute." operationId: v3-tags-create-tag parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateTagInputBody" required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeTag" description: Tag created successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag name already exists in this organization "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Create a Tag tags: - Tags and Comments x-speakeasy-name-override: CreateTag x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/tags/{tag_id}: delete: description: Delete a tag and all of its assignments from your organization. This action is permanent and cannot be undone.<br><br>Only the tag's creator or an organization admin can delete a `private` tag. Tags that are `shared` can be deleted by any organization member.<br><br>This endpoint does not cost any credits to execute. operationId: v3-tags-delete-tag parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID of the tag to delete. in: path name: tag_id required: true schema: description: The ID of the tag to delete. format: uuid type: string responses: "204": description: Tag deleted successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Delete a Tag tags: - Tags and Comments x-speakeasy-name-override: DeleteTag x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: "Retrieve a tag by its ID or name. Tag names are unique within an organization and can be used interchangeably with the tag ID in the path parameter.<br><br>Only tags that are visible to the caller are returned: private tags created by other users are not accessible unless your account is an organization admin.<br><br>This endpoint does not cost any credits to execute." operationId: v3-tags-get-tag parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID or name of the tag to retrieve. example: 123e4567-e89b-12d3-a456-426614174000 in: path name: tag_id required: true schema: description: The ID or name of the tag to retrieve. examples: - 123e4567-e89b-12d3-a456-426614174000 - my-tag type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeTag" description: Tag retrieved successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get a Tag tags: - Tags and Comments x-speakeasy-name-override: GetTag x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Update an existing tag in your organization. Only the fields provided in the request body will be updated; omitted fields are left unchanged.<br><br>Only the tag's creator or an organization admin can update a `private` tag. Tags with the `shared` setting can be updated by any organization member.<br><br>This endpoint does not cost any credits to execute. operationId: v3-tags-update-tag parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID of the tag to update. in: path name: tag_id required: true schema: description: The ID of the tag to update. format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateTagInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeTag" description: Tag updated successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag name already exists in this organization "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Update a Tag tags: - Tags and Comments x-speakeasy-name-override: UpdateTag x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/tags/{tag_id}/assignments: get: description: Retrieve a paginated list of assignments for a tag in your organization. Use query parameters to filter results by asset, created_by, or creation time. Only assignments for tags visible to your account are returned.<br><br>This endpoint does not cost any credits to execute. operationId: v3-tags-list-assignments parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID of the tag whose assignments to list. in: path name: tag_id required: true schema: description: The ID of the tag whose assignments to list. format: uuid type: string - description: Number of assignments to return per page. explode: false in: query name: page_size schema: default: 100 description: Number of assignments to return per page. format: int32 maximum: 1000 minimum: 1 type: integer - description: Pagination token from a previous response to retrieve the next page of results. explode: false in: query name: page_token schema: description: Pagination token from a previous response to retrieve the next page of results. type: string - description: "Sort order. Supported values: create_time_asc, create_time_desc." explode: false in: query name: order_by schema: default: create_time_desc description: "Sort order. Supported values: create_time_asc, create_time_desc." enum: - create_time_asc - create_time_desc type: string - description: The identifier of the asset (host IP, certificate SHA-256 fingerprint, or web property hostname:port). example: 8.8.8.8 explode: false in: query name: asset_id schema: description: The identifier of the asset (host IP, certificate SHA-256 fingerprint, or web property hostname:port). examples: - 8.8.8.8 - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf - platform.censys.io:443 type: string - description: RFC3339 timestamp. Only return assignments created before this time. explode: false in: query name: created_before schema: description: RFC3339 timestamp. Only return assignments created before this time. format: date-time type: string - description: RFC3339 timestamp. Only return assignments created after this time. explode: false in: query name: created_after schema: description: RFC3339 timestamp. Only return assignments created after this time. format: date-time type: string - description: Filter by the user ID of the user who created the assignment. explode: false in: query name: created_by schema: description: Filter by the user ID of the user who created the assignment. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeTagAssignmentsList" description: Tag assignments retrieved successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys List Tag Assignments tags: - Tags and Comments x-speakeasy-name-override: ListTagAssignments x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Assign a tag to an asset. Tag assignments are only visible to members of your organization, depending on the tag's privacy settings. You must have access to the tag to assign it to an asset.<br><br>This endpoint does not cost any credits to execute. operationId: v3-tags-create-assignment parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID of the tag to assign. in: path name: tag_id required: true schema: description: The ID of the tag to assign. format: uuid type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateTagAssignmentInputBody" required: true responses: "201": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeTagAssignment" description: Tag assignment created successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag assignment already exists for this asset "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Create a Tag Assignment tags: - Tags and Comments x-speakeasy-name-override: CreateTagAssignment x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/tags/{tag_id}/assignments/{assignment_id}: delete: description: Remove a tag assignment from an asset. This action is permanent and cannot be undone. Removing an assignment only detaches the tag from the specified asset; the tag itself is not deleted. Only the tag's creator or an organization admin can delete an assignment for a `private` tag. Assignments for `shared` tags can be deleted by any organization member.<br><br>This endpoint does not cost any credits to execute. operationId: v3-tags-delete-assignment parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The ID of the tag. in: path name: tag_id required: true schema: description: The ID of the tag. format: uuid type: string - description: The ID of the assignment to delete. in: path name: assignment_id required: true schema: description: The ID of the assignment to delete. format: uuid type: string responses: "204": description: Tag assignment deleted successfully headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Tag or assignment not found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Delete a Tag Assignment tags: - Tags and Comments x-speakeasy-name-override: DeleteTagAssignment x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/censeye/jobs: get: description: List CensEye pivot analysis jobs for the current organization. Results are paginated. Optionally filter by asset (host, web property, or certificate). operationId: v3-threathunting-censeye-jobs-list parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Number of results per page (max 100) explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by host IP address. example: 8.8.8.8 explode: false in: query name: host_id schema: description: Filter by host IP address. examples: - 8.8.8.8 type: string - description: Filter by web property (hostname:port). example: example.com:443 explode: false in: query name: webproperty_id schema: description: Filter by web property (hostname:port). examples: - example.com:443 type: string - description: Filter by certificate SHA-256 fingerprint. example: 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf explode: false in: query name: certificate_id schema: description: Filter by certificate SHA-256 fingerprint. examples: - 3daf2843a77b6f4e6af43cd9b6f6746053b8c928e056e8a724808db8905a94cf type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCenseyeJobsListResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Conflict "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: "Censys CensEye: List Jobs" tags: - Threat Hunting x-speakeasy-name-override: ListCenseyeJobs x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts [default pivot fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate. operationId: v3-threathunting-censeye-jobs-create parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateCenseyeJobInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCenseyeJob" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: "Censys CensEye: Create a Pivot Analysis Job" tags: - Threat Hunting - Adversary Investigation x-speakeasy-name-override: CreateCenseyeJob x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/censeye/jobs/{job_id}: get: description: Retrieve the current status of a CensEye pivot analysis job. Use this to poll for completion before fetching results.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module. operationId: v3-threathunting-censeye-jobs-get parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The unique identifier of the CensEye job. in: path name: job_id required: true schema: description: The unique identifier of the CensEye job. format: uuid type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCenseyeJob" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: "Censys CensEye: Get Job Status" tags: - Threat Hunting - Adversary Investigation x-speakeasy-name-override: GetCenseyeJob x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/censeye/jobs/{job_id}/results: get: description: Retrieve the results of a completed CensEye pivot analysis job. Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module. operationId: v3-threathunting-censeye-job-results parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The unique identifier of the CensEye job. in: path name: job_id required: true schema: description: The unique identifier of the CensEye job. format: uuid type: string - description: Number of results per page (max 100) explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeCenseyeResultsResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: "Censys CensEye: Get Job Results" tags: - Threat Hunting - Adversary Investigation x-speakeasy-name-override: GetCenseyeJobResults x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/certificate/{certificate_id}/observations/hosts: get: description: Retrieve the historical observations of hosts associated with a certificate. This is useful for threat hunting, detection engineering, and timeline generation. Certificate history is also visible to Adversary Investigation users in the Platform UI on the [certificate timeline](https://docs.censys.com/docs/platform-threat-hunting-use-cert-history-to-build-better-detections#/).<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account. You may also filter results by port and transport protocol.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 5 credits per page of results. operationId: v3-threathunting-get-host-observations-with-certificate parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: SHA-256 hash of the certificate example: 55af8a301eb51abdaf7c31bec951638fe5a99d5d92117eca2be493026613fa46 in: path name: certificate_id required: true schema: description: SHA-256 hash of the certificate examples: - 55af8a301eb51abdaf7c31bec951638fe5a99d5d92117eca2be493026613fa46 type: string - description: Only show ranges ending at or after this time (ISO 8601) example: "2023-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Only show ranges ending at or after this time (ISO 8601) examples: - "2023-01-01T00:00:00Z" type: string - description: Only show ranges starting at or before this time (ISO 8601) example: "2023-12-31T23:59:59Z" explode: false in: query name: end_time schema: description: Only show ranges starting at or before this time (ISO 8601) examples: - "2023-12-31T23:59:59Z" type: string - description: The port to filter by example: 443 explode: false in: query name: port schema: description: The port to filter by examples: - 443 format: int32 type: integer - description: The transport protocol to filter by example: TCP explode: false in: query name: protocol schema: description: The transport protocol to filter by examples: - TCP type: string - description: Pagination token from previous response to retrieve next page of results explode: false in: query name: page_token schema: description: Pagination token from previous response to retrieve next page of results type: string - description: Number of results per page. Maximum 100, defaults to 100 if not specified example: 50 explode: false in: query name: page_size schema: description: Number of results per page. Maximum 100, defaults to 100 if not specified examples: - 50 format: int32 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeHostObservationResponse" description: A list of host observations for the certificate headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Host History for a Certificate tags: - Threat Hunting - Adversary Investigation x-speakeasy-name-override: GetHostObservationsWithCertificate x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/host/{ip}/observations/endpoints: get: description: Retrieve historical endpoint-level hash observations for a host. This action returns time frames during which Censys observed host service endpoint body, favicon, and banner hash values. You must provide an `observation_type` and can optionally filter by a specific value using the `observation_value` parameter. You may also filter by port number.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module. operationId: v3-threathunting-endpoint-observations-on-host parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by port number example: 443 explode: false in: query name: port schema: description: Filter by port number examples: - 443 format: int32 type: integer - description: Filter by observation value for the selected observation_type explode: false in: query name: observation_value schema: description: Filter by observation value for the selected observation_type type: string - description: The IP address of a host. example: 8.8.8.8 in: path name: ip required: true schema: description: The IP address of a host. examples: - 8.8.8.8 format: ip type: string - description: Endpoint observation type to query. explode: false in: query name: observation_type required: true schema: description: Endpoint observation type to query. enum: - body_hash_sha1 - body_hash_sha256 - favicon_hash_md5 - favicon_hash_sha256 - favicon_hash_shodan - banner_hash_sha256 - endpoints_banner_hash_sha256 type: string - description: Order observations by these fields. Multiple values can be provided (e.g., ['port DESC', 'observation_value ASC']). explode: false in: query name: order_by schema: description: Order observations by these fields. Multiple values can be provided (e.g., ['port DESC', 'observation_value ASC']). items: enum: - port ASC - port DESC - observation_value ASC - observation_value DESC type: string type: - array - "null" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeHashObservationsOnHostResponse" description: A list of observation ranges headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Endpoint Observation History for a Host tags: - Threat Hunting - Adversary Investigation x-speakeasy-ignore: true x-speakeasy-name-override: ListEndpointObservationsOnHost x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/host/{ip}/observations/fingerprints: get: description: "Retrieve fingerprint observations for a host. You must provide an observation_type, and can optionally filter by port and observation_value. You may also filter or sort by transport_protocol when supported by the selected observation_type. The shared order_by schema includes transport_protocol for the fingerprint family, but requests for observation types whose timelines do not expose transport_protocol will be rejected if they attempt to sort by it.<br><br>Capability matrix:<br>- jarm_fingerprint: port, transport_protocol, observation_value<br>- jarm_cipher_and_version_fingerprint: port, transport_protocol, observation_value<br>- jarm_tls_extensions_sha256: port, transport_protocol, observation_value<br>- ja4tscan_fingerprint: port, observation_value<br>- ja3s: port, observation_value<br>- ja4s: port, observation_value<br>- tls_presented_chain_fingerprint_sha256: port, observation_value" operationId: v3-threathunting-fingerprint-observations-on-host parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by port number example: 443 explode: false in: query name: port schema: description: Filter by port number examples: - 443 format: int32 type: integer - description: Filter by transport protocol when supported by the selected observation_type example: tcp explode: false in: query name: transport_protocol schema: description: Filter by transport protocol when supported by the selected observation_type enum: - tcp - udp - icmp - quic examples: - tcp type: string - description: Filter by observation value for the selected observation_type explode: false in: query name: observation_value schema: description: Filter by observation value for the selected observation_type type: string - description: The IP address of a host. example: 8.8.8.8 in: path name: ip required: true schema: description: The IP address of a host. examples: - 8.8.8.8 format: ip type: string - description: Fingerprint observation type to query. explode: false in: query name: observation_type required: true schema: description: Fingerprint observation type to query. enum: - jarm_fingerprint - jarm_cipher_and_version_fingerprint - jarm_tls_extensions_sha256 - ja4tscan_fingerprint - ja3s - ja4s - tls_presented_chain_fingerprint_sha256 type: string - description: Order observations by these fields. Multiple values can be provided (e.g., ['port DESC', 'observation_value ASC']). transport_protocol ordering is only supported for observation types whose timelines expose that field; see the endpoint description for details. explode: false in: query name: order_by schema: description: Order observations by these fields. Multiple values can be provided (e.g., ['port DESC', 'observation_value ASC']). transport_protocol ordering is only supported for observation types whose timelines expose that field; see the endpoint description for details. items: enum: - port ASC - port DESC - transport_protocol ASC - transport_protocol DESC - observation_value ASC - observation_value DESC type: string type: - array - "null" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeHashObservationsOnHostResponse" description: A list of observation ranges headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Fingerprint Observation History for a Host tags: - Threat Hunting - Adversary Investigation x-speakeasy-ignore: true x-speakeasy-name-override: ListFingerprintObservationsOnHost x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/host/{ip}/observations/threats: get: description: Retrieve historical threat observations for a host. This endpoint returns time ranges during which threats were detected on the host.<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account.<br><br>You can filter by port number, protocol, threat name, and transport protocol.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. operationId: v3-threathunting-threats-on-host parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by port number example: 443 explode: false in: query name: port schema: description: Filter by port number examples: - 443 format: int32 type: integer - description: Filter by application protocol example: HTTP explode: false in: query name: protocol schema: description: Filter by application protocol examples: - HTTP type: string - description: Filter by threat name example: Acunetix explode: false in: query name: threat_name schema: description: Filter by threat name examples: - Acunetix type: string - description: Filter by transport protocol example: tcp explode: false in: query name: transport_protocol schema: description: Filter by transport protocol enum: - tcp - udp examples: - tcp type: string - description: The IP address of a host. example: 8.8.8.8 in: path name: ip required: true schema: description: The IP address of a host. examples: - 8.8.8.8 format: ip type: string - description: Order observations by these fields. Multiple values can be provided to sort by multiple fields (e.g., ['port DESC', 'protocol ASC']). explode: false in: query name: order_by schema: description: Order observations by these fields. Multiple values can be provided to sort by multiple fields (e.g., ['port DESC', 'protocol ASC']). items: enum: - port ASC - port DESC - protocol ASC - protocol DESC - transport_protocol ASC - transport_protocol DESC - threat_name ASC - threat_name DESC type: string type: - array - "null" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeThreatsOnHostResponse" description: A list of threat observation ranges headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Threat History for a Host tags: - Threat Hunting - Adversary Investigation x-speakeasy-ignore: true x-speakeasy-name-override: ListThreatsOnHost x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/scans/discovery: post: description: Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint. operationId: v3-threathunting-scans-discovery parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/ScansDiscoveryInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeTrackedScan" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: "Censys Live Discovery: Initiate a New Scan" tags: - Threat Hunting - Adversary Investigation x-speakeasy-name-override: CreateTrackedScan x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/scans/{scan_id}: get: description: Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. This endpoint does not cost any credits to execute. operationId: v3-threathunting-scans-get parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: The unique identifier of the tracked scan in: path name: scan_id required: true schema: description: The unique identifier of the tracked scan format: uuid type: string responses: "200": content: application/vnd.censys.api.v3.trackedscan.v1+json: schema: $ref: "#/components/schemas/ResponseEnvelopeTrackedScan" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: No scan found "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Scan Status tags: - Threat Hunting x-speakeasy-name-override: GetTrackedScanThreatHunting x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/threats: get: description: 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 Adversary Investigation module. operationId: v3-threathunting-threats-list parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Optional CenQL filter to constrain threats list example: "*" explode: false in: query name: query schema: description: Optional CenQL filter to constrain threats list examples: - "*" type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeThreatsListResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys List Active Threats tags: - Threat Hunting - Adversary Investigation x-speakeasy-name-override: ListThreats x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/value-counts: post: description: Get counts of web assets for specific field-value pairs and combinations of field-value pairs. This is similar to the [CensEye functionality](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#/) available in the Platform web UI, but it allows you to define specific fields of interest rather than the [default fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) leveraged by the tool in the UI.<br><br>Each array can only target fields within the same nested object and may contain at most 5 field-value pairs. For example, you can combine `host.services.port=80` and `host.services.protocol=SSH` in the same array, but you cannot combine `host.services.port=80` and `host.location.country="United States"` in the same array. You can input multiple arrays of objects in each API call.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module. This endpoint costs 1 credit per count condition (array of objects) included in the API call. operationId: v3-threathunting-value-counts parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchValueCountsInputBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeValueCountsResponse" description: OK headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Invalid input "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: "Censys CensEye: Retrieve Value Counts to Discover Pivots" tags: - Threat Hunting - Adversary Investigation x-speakeasy-name-override: ValueCounts x-microcks-operation: delay: 0 dispatcher: FALLBACK /v3/threat-hunting/web/{webproperty_id}/observations/threats: get: description: Retrieve historical threat observations for a web property. This endpoint returns time ranges during which threats were detected on the host.<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account.<br><br>You can filter by threat name.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. operationId: v3-threathunting-threats-on-web parameters: - description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. example: 11111111-2222-3333-4444-555555555555 explode: false in: query name: organization_id required: true schema: description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string - description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." example: 11111111-2222-3333-4444-555555555555 in: header name: X-Organization-ID schema: description: "The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter." examples: - 11111111-2222-3333-4444-555555555555 format: uuid type: string x-speakeasy-ignore: true - description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. example: "2024-01-01T00:00:00Z" explode: false in: query name: start_time schema: description: Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time. examples: - "2024-01-01T00:00:00Z" type: string - description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. example: "2024-01-31T23:59:59Z" explode: false in: query name: end_time schema: description: End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future. examples: - "2024-01-31T23:59:59Z" type: string - description: Number of results per page (max 100) example: 50 explode: false in: query name: page_size schema: default: 100 description: Number of results per page (max 100) examples: - 50 format: int32 maximum: 100 minimum: 1 type: integer - description: Pagination token from previous response explode: false in: query name: page_token schema: description: Pagination token from previous response type: string - description: Filter by threat name example: Acunetix explode: false in: query name: threat_name schema: description: Filter by threat name examples: - Acunetix type: string - description: A web property identifier in hostname:port format. example: platform.censys.io:80 in: path name: webproperty_id required: true schema: description: A web property identifier in hostname:port format. examples: - platform.censys.io:80 type: string - description: Order observations by these fields. Multiple values can be provided to sort by multiple fields (e.g., ['threat_name DESC']). explode: false in: query name: order_by schema: description: Order observations by these fields. Multiple values can be provided to sort by multiple fields (e.g., ['threat_name DESC']). items: enum: - threat_name ASC - threat_name DESC type: string type: - array - "null" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ResponseEnvelopeThreatsOnWebResponse" description: A list of threat observation ranges headers: Content-Type: schema: type: string X-Request-ID: schema: type: string "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad request "401": content: application/json: schema: $ref: "#/components/schemas/AuthenticationError" description: Request does not contain a valid Authorization token "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: User does not have permission to access this data "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Resource not found "409": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Feature not enabled "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal server error security: - PersonalAccessToken: [] summary: Censys Get Threat History for a Web Property tags: - Threat Hunting - Adversary Investigation x-speakeasy-ignore: true x-speakeasy-name-override: ListThreatsOnWeb x-microcks-operation: delay: 0 dispatcher: FALLBACK servers: - description: The Censys Platform API url: https://api.platform.censys.io tags: - description: Endpoints related to the Global Data product name: Global Data - description: Endpoints related to the Collections product name: Collections - description: Endpoints related to the Adversary Investigation product name: Threat Hunting - description: Endpoints related to the Adversary Investigation product name: Adversary Investigation - description: Endpoints related to the Account Management product name: Account Management - description: Endpoints related to the Supply Chain Intelligence product name: Supply Chain Intelligence - description: Endpoints related to asset tagging and commenting name: Tags and Comments x-readme: parameter-ordering: - path - body - query - cookie - form - header samples-languages: - shell - python - go - javascript - java x-speakeasy-globals: parameters: - in: query name: organization_id schema: type: string