Manage Multiple AWS Accounts - Netskope Technical Documentation

This endpoint allows you to create, update, delete, and download multiple AWS accounts.

Request

POST https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&<parameters>

Valid payload parameters are:

Key	Type	Value	Description
`op`	string	`create \| update \| delete \| download`	Required. Specifies operation to perform.
`app`	string	`"aws"`	Required. When `aws`, all required fields below must be supplied.
`accounts`	JSON array of objects	For create: "accounts": [ { "account_id": "<account_id>", "account_name": "<account_name>", "admin_email": "<admin_email>"}, { "account_id": "<account_id>"account_name": "<account_name>", "admin_email": "<admin_email>" } ] For update: "accounts": [ { "instance_name": "abcish", "admin_email": "admin@netskope.com", "use_for": [ "securityscan", "malware", "introspection" ], "securityscan_interval": "120" } ] For delete: "accounts": [ { "instance_name": "abcish" } ] For download CFT: { "app":"aws" "type": "cft", "use_for": [ "introspection" ] } ] For download CFT migration: { "app":"aws", "type": "cft", "mode": "migrate", "instance_name": "abcish", "admin_email": "admin@netskope.com", "use_for": [ "securityscan", "introspection" ], "securityscan_interval": "60" }	List of accounts with account_id and admin_email. Create allows adding multiple accounts at one time. Only one account can be updated or deleted at one time.
`instance_name`	string	`<instance_name>` Example: `"MYAWS_GOSKOPE"`	Required. The AWS instance name in the Netskope UI.
`mode`	string	`migrate`	Only for downloading the migration CFT.
`admin_email`	string	`<emailaddress@company.com>` Example: `admin@neskope.com`	Admin email for updating and downloading the migration CFT.
`type`	string	`cft`	Type of the download option. Currently only supported option is `cft`.
`use_for`	array	`"introspection" \|` `"malware"` \| `"securityscan"` Example: `["malware","introspection"]`	Required. Must not be an empty array. Items in the array must be supported by AWS. If it contains `"malware"` or `"introspection"`, must be also supplied. Note To use `introspection`, `malware`, and `securityscan`, first contact Netskope Support to have this feature enabled.
`securityscan_interval`	integer	In minutes. Example: `1440`	When used for `"securityscan"`, must be a value allowed by available intervals. If omitted, default value is the internally defined default value based on the app.

Example Create Request

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=create' --header 'Content-Type: application/json' --data-raw '{
    "app":"aws",
    "accounts": [
        {
            "account_id": "077000210270",
            "account_name": "Test-1"
            "admin_email": "admin@netskope.com"
        },
        {
            "account_id": "077000210271",
            "account_name": "Test-2"
            "admin_email": "admin@netskope.com"
        }
    ],
    "use_for": [
        "securityscan",
        "malware",
        "introspection"
    ],
    "securityscan_interval": "60"
}'

Example Update Request

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=update' --header 'Content-Type: application/json' --data-raw '{
    "app":"aws",
    "instance_name": "abcish",
    "admin_email": "admin@netskope.com"
    "use_for": [
        "securityscan",
        "malware",
        "introspection"
    ],
    "securityscan_interval": "120"
}'

Example Delete Request

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=delete' --header 'Content-Type: application/json' --data-raw '{
    "app":"aws",
    "account_id": "077000210270"
}'

Example Download CFT Request

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=download' --header 'Content-Type: application/json' --data-raw '{
    "app":"aws",
    "type": "cft",
    "use_for": [
        "introspection"
    ]
}'

Example Download Migration CFT for Existing Instances Request

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=download' --header 'Content-Type: application/json' --data-raw '{
    "app":"aws",
    "type": "cft",
    "mode": "migrate",
    "instance_name": "abcish",
    "admin_email": "admin@netskope.com",
    "use_for": [
        "securityscan",
        "introspection"
    ],
    "securityscan_interval": "60"
}'

Key

Type

Value

Description

op

string

create | update | delete | download

Required. Specifies operation to perform.

app

string

"aws"

Required. When aws, all required fields below must be supplied.

accounts

JSON array of objects

For create:

"accounts": [
{          
"account_id": "<account_id>", "account_name": "<account_name>",         "admin_email": "<admin_email>"},
{          
"account_id": "<account_id>"account_name": "<account_name>",       "admin_email": "<admin_email>"
}
]

For update:

"accounts": [
{
"instance_name": "abcish",
"admin_email": "admin@netskope.com",
"use_for": [
   "securityscan",
    "malware",
   "introspection"
],
"securityscan_interval": "120"
}
]

For delete:

"accounts": [
{
"instance_name": "abcish"
}
]

For download CFT:

{
"app":"aws"
"type": "cft",
"use_for": [
 "introspection"
    ]
}
]

For download CFT migration:

{
"app":"aws",
"type": "cft",
"mode": "migrate",
"instance_name": "abcish",
"admin_email": "admin@netskope.com",
"use_for": [
"securityscan",
"introspection"
 ],  "securityscan_interval": "60"
}

List of accounts with account_id and admin_email. Create allows adding multiple accounts at one time. Only one account can be updated or deleted at one time.

instance_name

string

<instance_name> Example: "MYAWS_GOSKOPE"

Required. The AWS instance name in the Netskope UI.

mode

string

migrate

Only for downloading the migration CFT.

admin_email

string

<emailaddress@company.com>

Example: admin@neskope.com

Admin email for updating and downloading the migration CFT.

type

string

cft

Type of the download option. Currently only supported option is cft.

use_for

array

"introspection" | "malware" | "securityscan"

Example: ["malware","introspection"]

Required. Must not be an empty array. Items in the array must be supported by AWS. If it contains "malware" or "introspection", must be also supplied.

Note

To use introspection, malware, and securityscan, first contact Netskope Support to have this feature enabled.

securityscan_interval

integer

In minutes. Example: 1440

When used for "securityscan", must be a value allowed by available intervals.

If omitted, default value is the internally defined default value based on the app.

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=create' --header 'Content-Type: application/json' --data-raw '{ "app":"aws", "accounts": [ { "account_id": "077000210270", "account_name": "Test-1" "admin_email": "admin@netskope.com" }, { "account_id": "077000210271", "account_name": "Test-2" "admin_email": "admin@netskope.com" } ], "use_for": [ "securityscan", "malware", "introspection" ], "securityscan_interval": "60" }'

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=update' --header 'Content-Type: application/json' --data-raw '{ "app":"aws", "instance_name": "abcish", "admin_email": "admin@netskope.com" "use_for": [ "securityscan", "malware", "introspection" ], "securityscan_interval": "120" }'

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=delete' --header 'Content-Type: application/json' --data-raw '{ "app":"aws", "account_id": "077000210270" }'

curl --location --request POST 'https://<tenant-URL>/api/v1/public_cloud/account?token=<token>&op=download' --header 'Content-Type: application/json' --data-raw '{ "app":"aws", "type": "cft", "mode": "migrate", "instance_name": "abcish", "admin_email": "admin@netskope.com", "use_for": [ "securityscan", "introspection" ], "securityscan_interval": "60" }'