Docy

Update an App Instance

Update an App Instance

This endpoint updates an existing app instance. Size limit is 500 app instances max per request with the rate limit of one request every 10 minutes.

Request Endpoint

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

Valid parameters are:

KeyTypeValueDescription
opstringupdateRequired. Operation performed.
appstringEx:
Amazon Web Services | Amazon S3 | Amazon EC2 | Amazon DynamoDB | Microsoft Azure | Microsoft Office 365 Sharepoint Sites | Microsoft Office 365 OneDrive for Business | Box | Slack 
Required. Name of the application. 
instance_idstringEx: 123451234512Required. For AWS, use the account ID. For Azure, use the Subscription. For GCP, use the Project.

The app + instance_id combo must be new.

instance_namestringEx: "MYAWS_GOSKOPE"Required. Used to change instance name, and must be new.

Note

Name should be unique within app + instance_id or app + instance_name.

tagsarray of one string, or an empty arraySanctioned | Unsanctioned | <blank>Required.

Example Update App Instance Request

POST 'https://<tenant-URL>/api/v1/app_instances?token=<token>&op=update' 
--header 'Content-Type: application/json' 
--data-raw '{
   "instances":[
    {
"instance_id": "123451234512",
"instance_name":"New Instance-3",
"app":"Box",
"tags":[
"Sanctioned"
]
},
{
"instance_id": "123451234512",
"instance_name":"New Instance-4",
"app":"Amazon EC2",
"tags":[
"Unsanctioned"
]
}
]
}'
Share this Doc
In this topic ...