GET: SPF Domains Finding Details – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/companies/company_guid/findings?risk_vector=spf

Get an organization’s SPF Domains finding details.

Parameters

For details specific to SPF Domains, use the ?risk_vector=spf parameter. Other query parameters are listed in GET: Finding Details.

Example Response

{
  "links":{
    "next":null,
    "previous":null
  },
  "count":31,
  "results":[
    […]
    {
      "temporary_id":"A9Jq47BBje41bb19b93fac69219d98b4ea4a02b440",
      "affects_rating":false,
      "assets":[
        {
          "asset":"goliathinvest.com",
          "identifier":null,
          "category":"critical",
          "importance":1.0,
          "is_ip":false
        }
      ],
      "details":{
        "check_pass":" ",
        "diligence_annotations":{
          […]
          "goliathinvest.com":{
            "score":"good",
            "message":"Effective",
            "mech_tags":{ },
            "spf_record":[
              "v=spf1 include:domain.com ~all"
            ]
          },
          "total":{
            "score":"good",
            "message":"Effective",
            "mech_tags":{ },
            "spf_record":[ ]
          }
        },
        "grade":"GOOD",
        "remediations":[ ],
        "sample_timestamp":"2021-10-31T02:13:14Z",
        "vulnerabilities":[ ],
        "rollup_end_date":"2021-10-31",
        "rollup_start_date":"2021-05-16"
      },
      "evidence_key":"goliathinvest.com",
      "first_seen":"2021-05-16",
      "last_seen":"2021-10-31",
      "related_findings":[ ],
      "risk_category":"Diligence",
      "risk_vector":"spf",
      "risk_vector_label":"SPF",
      "rolledup_observation_id":"W0PlQiePjSEXMclYSj1BJA==",
      "severity":1.0,
      "severity_category":"minor",
      "tags":[ ],
      "remediation_history":{
      "last_requested_refresh_date":null,
      "last_refresh_status_date":null,
      "last_refresh_status_label":null,
      "last_refresh_reason_code":null
    },
    "asset_overrides":[
      {
        "asset":"goliathinvest.com",
        "importance":"high",
        "override_importance":"high"
      }
    ],
      "duration":null,
      "comments":"Richard Kuga from Saperix, Inc. said: \"Here are some findings\" at 2017-08-18 15:32 UTC;\Cate Remediator said: \"I will take a look\" at 2018-05-09 15:24 UTC;\Richard Kuga from Saperix, Inc. replied: \"Prioritize for next week\" at 2021-03-16 19:38 UTC",
      "remaining_decay":null
    }
  ]
}

Response Attributes

Field							Description
links Object							Navigation for multiple pages of results. See pagination.
	next String						The URL for navigating to the next page of results.
	previous String						The URL for navigating to the previous page of results.
count Integer							The number of findings.
results Array							Findings and their details.
	Object						A finding.
		temporary_id String					A temporary identifier for this finding.
		affects_rating Boolean					`true` = This finding has an impact on the letter grade.
		assets Array					Asset details.
			Object				An asset.
				asset String			The asset name.
				identifier Null			For internal Bitsight use.
				category String			The Bitsight-calculated asset importance.
				importance Decimal			The Bitsight-calculated asset importance.
				is_ip Boolean			`true` = This asset is an IP address.
		details Object					Details of this finding.
			check_pass String				For internal Bitsight use.
			diligence_annotations Object				Diligence finding details.
				Asset Object			An asset.
					score String		An assessment of this asset.
					message String		Indicates if the SPF record is effective.
					mech_tags Object		Mechanism tags.
						?all String
					spf_record Array		The SPF record version, followed by the mechanism that defines the IP addresses allowed to send mail from the domain.
				total Object
					score String		An assessment of this asset.
					message String		Indicates if the SPF record is effective.
					mech_tags Object		Mechanism tags.
					spf_record Array		The SPF record version, followed by the mechanism that defines the IP addresses allowed to send mail from the domain.
			grade String				This finding’s grade.
			remediations Array				Information about the finding and instructions to remediate it.
			sample_timestamp String [`YYYY-MM-DDTHH:MM:SSZ`]				The date and time when this finding was observed.
			vulnerabilities Array				Vulnerabilities associated with this finding.
			rollup_end_date String [`YYYY-MM-DD`]				The date when this finding was last observed.
			rollup_start_date String [`YYYY-MM-DD`]				The date when this finding was first observed.
		evidence_key String					The asset attributed to the finding.
		first_seen String [`YYYY-MM-DD`]					The date when this observation was first observed.
		last_seen String [`YYYY-MM-DD`]					The date when this observation was last observed.
		related_findings Array					Details of related findings.
		risk_category String					The risk category associated with this finding.
		risk_vector String					The slug name of the risk vector.
		risk_vector_label String					The display name of the risk vector.
		rolledup_observation_id String					A stable and randomized identifier for findings. It is assigned to a finding when one or more observations with largely similar key properties occur in close succession.
		severity Decimal					This finding’s Bitsight severity.
		severity_category String					This finding’s Bitsight severity.
		tags Array					Infrastructure tags identifying the asset.
		remediation_history Object					The finding’s remediation and refresh history.
			last_requested_refresh_date String [`YYYY-MM-DD`]				The date when a finding refresh that included this finding was last requested.
			last_refresh_status_date String [`YYYY-MM-DD`]				The date when this finding’s remediation status was last refreshed.
			last_refresh_status_label String [`YYYY-MM-DD`]				The current refresh status of this finding.
			last_refresh_reason_code String [`YYYY-MM-DD`]				The current remediation status of this finding.
		asset_overrides Array					User-assigned asset importance details.
			asset String				The domain or IP address.
			importance String				The user-assigned asset importance.
			override_importance String				For internal Bitsight use.
		duration Null					For internal Bitsight use.
		comments String					A thread of finding comments.
		remaining_decay Integer [`Calendar Days`]					The remaining finding lifetime.

August 22, 2022: Published.

Parameters

Example Response

Response Attributes

Related articles