Update an AWS Instance - Netskope Technical Documentation

This endpoint updates an AWS instance.

Request

POST https://<tenant-URL>/api/v1/introspection_instance?token=<token>&op=update

Valid payload parameters are:

Key	Type	Value	Description
`app`	string	`"aws"`	Required. When `aws`, all required fields below must be are supplied. The combined IaaS instances must not exceed 200, the default max. To have the max increased, contact Netskope Support.
`instance_name`	string	`<instance_name>` Example: `"MYAWS_GOSKOPE"`	Required. The AWS instance name in the Netskope UI.
`role_arn`	string	`<arn_aws_iam_role_name>` Example: `"arn:aws:iam::202763083689:role/MYAWS_GOSKOPE"`	Required. The ARN role name for the AWS account.
`trail_name`	string	`<cloudtrail_name>` Example: `"MYAWS_GOTASKOPE_TRAIL"`	Required for `"introspection"` and `"malware"`. The trail name for the AWS account.
`trail_region`	string	`<aws_region_id>` Example: `"ap-south-1"`	Required. The trail region for the AWS account.
`admin_email`	sting	`<emailaddress@company.com>` Example: `admin@neskope.com`	Required. The admin’s email address.
`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.

Response

Responses for AWS are:

Key		Value
`app`		`aws`
`instance`	`account_id`	Netskope account ID
	`external_id`	Netskope external ID
	`instance_name`	`<instance_name>`
	`oath`	Permission needed `"<json_string>"` or `"<instruction>"` Value is based on the combination in `"use_for"` supplied in the request.

Key

Type

Value

Description

app

string

"aws"

Required. When aws, all required fields below must be are supplied. The combined IaaS instances must not exceed 200, the default max. To have the max increased, contact Netskope Support.

instance_name

string

<instance_name> Example: "MYAWS_GOSKOPE"

Required. The AWS instance name in the Netskope UI.

role_arn

string

<arn_aws_iam_role_name>

Example: "arn:aws:iam::202763083689:role/MYAWS_GOSKOPE"

Required. The ARN role name for the AWS account.

trail_name

string

<cloudtrail_name>

Example: "MYAWS_GOTASKOPE_TRAIL"

Required for "introspection" and "malware". The trail name for the AWS account.

trail_region

string

<aws_region_id>

Example: "ap-south-1"

Required. The trail region for the AWS account.

admin_email

sting

<emailaddress@company.com>

Example: admin@neskope.com

Required. The admin’s email address.

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.

Key

Value

app

aws

instance

account_id

Netskope account ID

external_id

Netskope external ID

instance_name

<instance_name>

oath

Permission needed

"<json_string>" or "<instruction>"

Value is based on the combination in "use_for" supplied in the request.