logo

Cloud Resource

This document describes the API for reading Cloud Resources.

List Cloud Resources

Returns a list of Cloud Resources.

Search parameters

Filter Description
cloud_resource_type The type of this Cloud Resource
created_at The date this Cloud Resource was created
id The ID of the Cloud Resource
in_audit_scope Flag to indicate if this Cloud Resource is in scope. [DEPRECATED - Use the Cloud Resource Framework Asset Scope endpoint]
region The region this Cloud Resource belongs to
third_party_id The identifier for this Cloud Resource on the vendor side
updated_at The date this Cloud Resource was last updated
vendor_name The name of the vendor that this Cloud Resource is from
Securityheader_authorization
Request
query Parameters
include
boolean

Set to true along with relationships to return the entire relationship data in the included key within the response.

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page.

q
string

Search and filter the Cloud Resource data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/cloud_resources
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get a Cloud Resource
Returns a single Cloud Resource by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
get/cloud_resources/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Update a Cloud Resource
Update a Cloud Resource by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
query Parameters
in_audit_scope
boolean
Flag to indicate if this Cloud Resource is in scope. [DEPRECATED - Use the Cloud Resource Framework Asset Scope endpoint]


 
out_of_audit_scope_reason
string
Out of scope reason if the Cloud Resource is not in scope. [DEPRECATED - Use the Cloud Resource Framework Asset Scope endpoint]


 Enum: "development_asset" "staging_asset" "out_of_scope_production_asset"  
owner_id
string <uuid> 
ID of the User that's the owner of this Cloud Resource.


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
put/cloud_resources/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
➔ Next to Cloud Resource Framework Asset Scope