Cloud Cost Perspectives Folders

Group your Perspectives using Folders in ways that are more meaningful to your business needs.

Create a Perspective folder

Create a Perspective Folder.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

Request body containing Perspective's CEViewFolder object

object (CEViewFolder)

This object will contain the complete definition of a Cloud Cost Perspective

perspectiveIds
Array of strings
Responses
400

Bad Request

500

Internal server error

default

Returns a created CEViewFolder object with all its details

post/ccm/api/perspectiveFolders/create
Request samples
application/json
{
  • "ceViewFolder": {
    },
  • "perspectiveIds": [
    ]
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete a folder

Delete a Folder for the given Folder ID.

Securityx-api-key
Request
path Parameters
folderId
required
string

Unique identifier for the Perspective folder

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

A boolean whether the delete was successful or not

delete/ccm/api/perspectiveFolders/{folderId}
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch folders for an account

Fetch folders given an accountId

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

folderNamePattern
string

Search by folder name pattern

Responses
400

Bad Request

500

Internal server error

default

Returns List of CEViewFolders

get/ccm/api/perspectiveFolders
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update a folder

Update a folder

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

Request body containing ceViewFolder object

uuid
string

unique id

accountId
string

account id

name
required
string [ 1 .. 80 ] characters

name

pinned
boolean

pinned

tags
Array of strings

Tags

description
string

Description of the entity

viewType
string

view type

Enum: "SAMPLE" "CUSTOMER" "DEFAULT"
createdAt
integer <int64>

Time at which the entity was created

lastUpdatedAt
integer <int64>

Time at which the entity was last updated

object (EmbeddedUser)
object (EmbeddedUser)
Responses
400

Bad Request

500

Internal server error

default

CEViewFolder object

put/ccm/api/perspectiveFolders
Request samples
application/json
{
  • "uuid": "string",
  • "accountId": "string",
  • "name": "string",
  • "pinned": true,
  • "tags": [
    ],
  • "description": "string",
  • "viewType": "SAMPLE",
  • "createdAt": 0,
  • "lastUpdatedAt": 0,
  • "createdBy": {
    },
  • "lastUpdatedBy": {
    }
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Return details of all the Perspectives

Return details of all the Perspectives for the given account ID and folder

Securityx-api-key
Request
path Parameters
folderId
required
string

Unique identifier for folder

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Returns a List of Perspectives

get/ccm/api/perspectiveFolders/{folderId}/perspectives
Request samples
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Move a Perspective

Move a perspective from a folder to another.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

Request body containing perspectiveIds to be moved and newFolderId

newFolderId
string
perspectiveIds
Array of strings
Responses
400

Bad Request

500

Internal server error

default

Returns the new CEView object

post/ccm/api/perspectiveFolders/movePerspectives
Request samples
application/json
{
  • "newFolderId": "string",
  • "perspectiveIds": [
    ]
}
Response samples
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}