POST: Set an End Date for Company-Provided Assets

https://api.bitsighttech.com/ratings/v1/companies/infrastructure/expiration

Set an end date for a company-provided asset. The removal of company-provided assets takes 1-2 days to process. This change affects ratings if there are any associated findings.

Learn more about infrastructure management.

Parameters

* Required.

expirations

* Required.

[Data] Identify infrastructure to be end-dated.

Value: [Array] Up to 50 infrastructure objects.

{
  "company": "entity_guid",
  "infrastructure": "IP or CIDR",
  "infrastructure_type": "domain",
  "end_date": "YYYY-MM-DD"
}

expirations:company

* Required.

[Data] Identify the company attributed to the infrastructure.

Value: [String] Company unique identifier [entity_guid]. See GET: Ratings Tree.

expirations:infrastructure

* Required.

[Data] Identify the infrastructure by asset name.

Value: [String]

• Domain name
• IP address name
• CIDR name

expirations:end_date

[Data] Define the end date.

Value: [String] The end date [YYYY-MM-DD], which could be any day from 2011-01-01 (the start of the Bitsight platform) through today. Future dates are not permitted.

↻ Default: Date of request (today).

expirations:infrastructure_type

[Data] Identify the type of infrastructure. If instructure_type is not provided outside of expirations, this is used instead.

Value: [String]

• cidr
• domain

infrastructure_type

[Data] Identify the type of infrastructure. If not provided, the expirations parameter has infrastructure_type data, which is used instead.

Value: [String]

• cidr
• domain

Example Request

cURL:

curl -X POST --data-ascii '{
  "expirations": [
    {
      "company": "a940bb61-33c4-42c9-9231-c8194c305db3"",
      "infrastructure": "12.3.456.7/20",
      "infrastructure_type": "cidr",
    },
    {
      "company": "a940bb61-33c4-42c9-9231-c8194c305db3"",
      "infrastructure": "domain.tld",
      "infrastructure_type": "domain",
      "end_date": "2020-01-01"
    }
  ]
}' https://api.bitsighttech.com/ratings/v1/companies/infrastructure/expiration -u api_token: --header "Content-Type:application/json"

JSON:

{
  "expirations": [
    {
      "company": "a940bb61-33c4-42c9-9231-c8194c305db3"",
      "infrastructure": "12.3.456.7/20",
      "infrastructure_type": "cidr",
    },
    {
      "company": "a940bb61-33c4-42c9-9231-c8194c305db3"",
      "infrastructure": "domain.tld",
      "infrastructure_type": "domain",
      "end_date": "2020-01-01"
    }
  ]
}

Example Response

[
  {
    "company": "a940bb61-33c4-42c9-9231-c8194c305db3",
    "infrastructure": "12.3.456.7/20",
    "infrastructure_type": "cidr",
    "end_date": "2025-05-29"
  }
]

Response Attributes

company

infrastructure

infrastructure_type

end_date

Response Codes

See the common errors and status codes.

201

End date request successfully submitted.

400

Bad data.

401

Unauthorized.

403

You do not have control over the infrastructure and are not permitted to modify it.

404

The specified resource was not found.