GET: Company-Provided Assets

https://api.bitsighttech.com/v1/companies/infrastructure/requests/

See your Company-Provided Assets.

Only Admin can see company-provided assets. See permissions.

Parameters

* Required.

See query parameters for details on the q parameter.

attributed_to

* Required.

[Path] Filter by company.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

reason.slug

[Query] Filter by reason.

Value: [String] See reasons.

  • dev = Development/Testing infrastructure
  • office = Office assets
  • cloud = Dynamically scaled cloud assets
  • pub = Publicly visible backend systems
  • other = Other
request_date

[Query] Filter by request date, including:

  • request_date
  • request_date_gt
  • request_date_gte
  • request_date_lt
  • request_date_lte

Value: [String] YYYY-MM-DD

requested_by

[Query] Filter by requester.

Value: [String] User unique identifier [user_guid]. See GET: Users.

status.slug

[Query] Filter by request status.

Value: [String] See request statuses.

  • PENDING
  • ERROR
  • ADDED
  • EXPIRED
value

[Query] Filter by domain or CIDR.

Value: [String]

  • DOMAIN
  • CIDR

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/infrastructure/requests/ -u api_token:

Example Response

{
   "links":{
      "next":null,
      "previous":null
   },
   "count":6,
   "results":[
      […]
      {
         "temporary_id":"TDUvt5o2mEe1d5be1c7f2f456670de3d53c7b54f4a",
         "value":"24.6.0.0/30",
         "type":"cidr",
         "status":{
            "slug":"error",
            "name":"Error"
         },
         "attributed_to":{
            "guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
            "name":"Saperix, Inc."
         },
         "requested_by":{
            "guid":"11111111-aaaa-1111-aaaa-111111111111",
            "name":"Arnold Brown"
         },
         "request_date":"2023-04-19",
         "reason":{
            "slug":"cloud",
            "name":"Dynamically scaled cloud assets"
         },
         "message":"Active CIDR already exists"
      }
   ]
}

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 assets.
results

Array

Assets and their infrastructure changes.
  Object An asset.
 
temporary_id

String

A temporary identifier for this asset.
value

String

The asset’s name.
type

String

The type of asset.
status

Object

The request status.
 
slug

String

The status slug name.
name

String

The status name.
attributed_to

Object

The company that owns the asset.
 
guid

String [entity_guid]

The unique identifier of the company attributed to the asset.
name

String

The name of the company attributed to the asset.
requested_by

Object

The user who requested the change.
 
guid

String [user_guid]

This user’s unique identifier.
name

String

This user’s name.
request_date

String [YYYY-MM-DD]

When the request was submitted.
reason

Object

The reason why the asset was added.
 
slug

String

The reason slug name.
name

String

The reason.
message

String

The status message.

Response Codes

See common errors and status codes.

202 – Accepted
Everything worked as expected.
  • May 10, 2023: reason & message fields.
  • March 31, 2023: Published.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.