Suspend Instance Endpoint

curl --request PATCH \
  --url https://api.example.com/partner/instances/suspend \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'instance_id=<string>'

{
  "instanceID": "<string>",
  "name": "<string>",
  "enabled": 123
}

Instances

Suspend Instance Endpoint

This endpoint will suspend an instance under your partner account.

Notes:

Suspended instances are NOT visible within the MSP web interface.
Suspended instances are not shown in the API “Get All” request.
To restore a suspended instance or organization, the instanceID is required, so this should be documented so that a restore can later be performed.
Suspended Instances do not stop working, only ACCESS to the suspended instance is blocked.
If an organization is suspended, access to instances and sub organizations within that organization are also blocked.

Required headers:

Authorization: access_token {token}

PATCH

partner

instances

suspend

Suspend Instance Endpoint

curl --request PATCH \
  --url https://api.example.com/partner/instances/suspend \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'instance_id=<string>'

{
  "instanceID": "<string>",
  "name": "<string>",
  "enabled": 123
}

Headers

Authorization

string

Body

application/x-www-form-urlencoded

instance_id

string

ID of the organization under suspension.

Response

Represents the JSON structure for suspending an instance.

instanceID

string | null

The unique identifier for the instance.

name

string | null

The name of the instance.

enabled

integer<int32>

The enabled status of the instance.

Create Instances Endpoint Reactivate Instance Endpoint

Overview

Dashboards

Instances

Login

Scans

Users

Vulnerability Assets

Suspend Instance Endpoint

Headers

Body

Response