Support Open Console

Stack

Stack of resources deployed to Clouds

List Stacks

get/stacks

List Stacks.

Request
query Parameters
cursor
string <byte>

An encoded value used to retrieve the next set of results for a query that returns more than limit results.

limit
integer <= 100
Default: 25

The maximum number of records to return.

provider
string

Cloud provider.

Enum: "aws" "azure"
scannerStack
string <uuid>

Lists Storage Stacks belong to the specified Scanner Stack.

sort
string

The attribute to sort the responded objects with the specified order, asc (default) or desc. Supported attributes: name. Response contains only Stacks that have the attribute.

Example: sort=name:asc
status
string

Stack status

Enum: "ok" "creating" "creation-failed"
type
string

Stack's type.

Enum: "scanner" "storage"
header Parameters
Api-Version
required
any

API version.

Example: v1
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "stacks": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

Create Stack

post/stacks

Create a Stack. Use Describe Stack or List Stacks API to query the Stack's creation status.

Request
header Parameters
Api-Version
required
any

API version.

Example: v1
Request Body schema: application/json

request body

One of:
required
object or object

The detailed information specific to each cloud provider.

provider
required
string

Cloud provider.

Enum: "aws" "azure"
type
required
string

The stack's type.

Value: "scanner"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "type": "storage",
  • "scannerStack": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
  • "provider": "aws",
  • "details": {
    }
}
Response samples
application/json
{
  • "stackID": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff"
}

Describe Stack

get/stacks/{stackID}

Describe a Stack.

Request
path Parameters
stackID
required
string <uuid>

Stack's ID.

header Parameters
Api-Version
required
any

API version.

Example: v1
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "type": "storage",
  • "scannerStack": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
  • "storage": "scanning-bucket",
  • "stackID": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff",
  • "name": "fss-scanner-stack",
  • "provider": "aws",
  • "status": "ok",
  • "statusDetail": "failed to retrieve scanner stack",
  • "created": "2020-05-14T10:49:00.000Z",
  • "updated": "2020-05-14T10:49:00.000Z",
  • "details": {}
}

Delete Stack

delete/stacks/{stackID}

Delete a Stack.

Request
path Parameters
stackID
required
string <uuid>

Stack's ID.

header Parameters
Api-Version
required
any

API version.

Example: v1
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "message": "Error message"
}