GET/cspm/resources
This endpoint returns information regarding the resources available on your onboarded cloud accounts.
Request
Format
GET/cspm/resources/{id}Parameters
Parameter | Type | Optional | Description |
|---|---|---|---|
| String | Yes | The ID of the resource you want to display the information for. If this parameter is not specified in the request, the response will include information for all the resource available across your cloud accounts. |
Examples
Request information for all resources available on your cloud accounts:
GET/cspm/resources
Request information for resource 34a3a231-73d1-4945-8376-a41f7b******:
GET/cspm/resources/34a3a231-73d1-4945-8376-a41f7b******
Response
Format
{
"data": [
{
"id": "string",
"type": "resource",
"attributes": {
"resource_name": "string",
"resource_region": "string",
"resource_type": "string"
},
"links": {
"self": "string"
}
}
],
"links": {
"self": "string",
"next": "string"
},
"meta": {
"total": 0,
"elapsed": 0
}
}Attributes
This endpoint returns an object containing multiple attributes:
Attribute | Type | Description |
|---|---|---|
| Array | A list of attributes containing information on a specific resource. |
| String | The ID of the scan group. |
| String | The type of the group. Possible values: |
| Array | Provides scan group settings information. |
| String | The name of the resource. |
| String | The region the resource is located in. |
| String | The type of the resource. |
| Array | Provides links relevant to this scan group. |
| String | A direct link this scan group settings information. |
The below attributes are returned only when requesting information for all scan groups in the company (no | ||
| Array | Provides links that allow you navigate between pages. |
| String | A direct link this resource information. |
| String | A direct link the next resource information. |
| Array | Provides overall information regarding to the information returned by the request. |
| Integer | The total number of results returned by your request. |
| Integer | The number of results you have viewed, including the one being displayed. |
Examples
Information was requested for all resources available on your onboarded cloud accounts:
{
"data": [
{
"id": "0e1f4b58-a373-44d4-8d01-1a7ad3******",
"type": "resource",
"attributes": {
"resource_name": "0e1f4b58-a373-44d4-8d01-1a7ad3******",
"resource_region": "ap-southeast-1",
"resource_type": "ACM Certificate"
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/resources/0e1f4b58-a373-44d4-8d01-1a7ad3******"
}
},
{
"id": "34a3a231-73d1-4945-8376-a41f7b******",
"type": "resource",
"attributes": {
"resource_name": "34a3a231-73d1-4945-8376-a41f7b******",
"resource_region": "ap-southeast-1",
"resource_type": "ACM Certificate"
},
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/resources/34a3a231-73d1-4945-8376-a41f7b******"
}
},
{
"...": "..."
}
],
"links": {
"self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/resources?page_limit=500",
"next": "https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/resources?page_limit=500&page_cursor=eyJ0b3RhbCI6IDE3NTcsICJlbGFwc2VkIjogNTAwLCAibm9fbGF0ZXJfdGhhbiI6ICIyMDI0LTAxLTE0VDE3OjAzOjM0Ljc1NDY1OCIsICJuZXh0X2JlZ2luX3VpZCI6ICJzdWJuZXQtZjMwZmNkOTUifQ%3D%3D"
},
"meta": {
"total": 1757,
"elapsed": 500
}
}Information was requested for resource 34a3a231-73d1-4945-8376-a41f7b******:
{
"data": {
"id": "string",
"type": "resource",
"attributes": {
"resource_name": "34a3a231-73d1-4945-8376-a41f7b******",
"resource_region": "ap-southeast-1",
"resource_type": "ACM Certificate"
},
"links": {
"self":"https://api.staging.cs.gravityzone.bitdefender.com/v1/cspm/resources/34a3a231-73d1-4945-8376-a41f7b******"
}
}
}